Merge branch 'improve-autodocs-for-models' into 'master'

Improve autodocs for models & more

See merge request allianceauth/allianceauth!1435
This commit is contained in:
Ariel Rin 2022-07-07 07:38:58 +00:00
commit 3706a1aedf
5 changed files with 7 additions and 36 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

@ -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

@ -3,6 +3,7 @@ sphinx>=3.2.1,<4.0.0
sphinx_rtd_theme==0.5.0
recommonmark==0.6.0
Jinja2<3.1
sphinxcontrib-django2
# Autodoc dependencies
django>=3.2,<4.0.0