This commit is contained in:
Ariel Rin
2022-07-07 18:07:49 +10:00
17 changed files with 103 additions and 65 deletions

View File

@@ -44,6 +44,8 @@ extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'recommonmark',
'sphinxcontrib_django2',
'sphinx.ext.viewcode',
]
# Add any paths that contain templates here, relative to this directory.

View File

@@ -4,36 +4,4 @@ django-esi
The django-esi package provides an interface for easy access to the ESI.
Location: ``esi``
This is an external package. Please also see `here <https://gitlab.com/allianceauth/django-esi>`_ for it's official documentation.
clients
===========
.. automodule:: esi.clients
:members: esi_client_factory
:undoc-members:
decorators
===========
.. automodule:: esi.decorators
:members:
:undoc-members:
errors
===========
.. automodule:: esi.errors
:members:
:undoc-members:
models
===========
.. automodule:: esi.models
:members: Scope, Token
:exclude-members: objects, provider
:undoc-members:
This is an external package. Please see `here <https://django-esi.readthedocs.io/en/latest/>`_ for it's documentation.

View File

@@ -11,5 +11,4 @@ models
.. automodule:: allianceauth.eveonline.models
:members:
:exclude-members: objects, provider
:undoc-members:
:exclude-members: DoesNotExist, MultipleObjectsReturned

View File

@@ -11,4 +11,5 @@ To reduce redundancy and help speed up development we encourage developers to ut
eveonline
notifications
testutils
utils
```

View File

@@ -13,7 +13,8 @@ models
===========
.. autoclass:: allianceauth.notifications.models.Notification
:members: Level, mark_viewed, set_level
:members:
:exclude-members: DoesNotExist, MultipleObjectsReturned, save
managers
===========

View File

@@ -0,0 +1,14 @@
=============================
utils
=============================
Utilities and helper functions.
Location: ``allianceauth.utils``
cache
===========
.. automodule:: allianceauth.utils.cache
:members:
:undoc-members:

View File

@@ -4,6 +4,7 @@ sphinx_rtd_theme>=1.0.0,<2.0.0
recommonmark==0.7.1
Jinja2<3.1
docutils==0.16
sphinxcontrib-django2
# Autodoc dependencies
celery>=5.2.0,<6.0.0