mirror of
https://gitlab.com/allianceauth/allianceauth.git
synced 2025-07-09 20:40:17 +02:00
Merge branch 'improve-autodocs-for-models' into 'master'
Improve autodocs for models & more See merge request allianceauth/allianceauth!1435
This commit is contained in:
commit
3706a1aedf
@ -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.
|
||||
|
@ -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.
|
||||
|
@ -11,5 +11,4 @@ models
|
||||
|
||||
.. automodule:: allianceauth.eveonline.models
|
||||
:members:
|
||||
:exclude-members: objects, provider
|
||||
:undoc-members:
|
||||
:exclude-members: DoesNotExist, MultipleObjectsReturned
|
||||
|
@ -13,7 +13,8 @@ models
|
||||
===========
|
||||
|
||||
.. autoclass:: allianceauth.notifications.models.Notification
|
||||
:members: Level, mark_viewed, set_level
|
||||
:members:
|
||||
:exclude-members: DoesNotExist, MultipleObjectsReturned, save
|
||||
|
||||
managers
|
||||
===========
|
||||
|
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user