diff --git a/docs/conf.py b/docs/conf.py index 64cb80f0..71e699df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. diff --git a/docs/development/tech_docu/api/esi.rst b/docs/development/tech_docu/api/esi.rst index a6942e69..e9bedd8e 100644 --- a/docs/development/tech_docu/api/esi.rst +++ b/docs/development/tech_docu/api/esi.rst @@ -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 `_ 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 `_ for it's documentation. diff --git a/docs/development/tech_docu/api/eveonline.rst b/docs/development/tech_docu/api/eveonline.rst index 054f7cb6..c09f76e7 100644 --- a/docs/development/tech_docu/api/eveonline.rst +++ b/docs/development/tech_docu/api/eveonline.rst @@ -11,5 +11,4 @@ models .. automodule:: allianceauth.eveonline.models :members: - :exclude-members: objects, provider - :undoc-members: + :exclude-members: DoesNotExist, MultipleObjectsReturned diff --git a/docs/development/tech_docu/api/notifications.rst b/docs/development/tech_docu/api/notifications.rst index be324576..7a4fc75b 100644 --- a/docs/development/tech_docu/api/notifications.rst +++ b/docs/development/tech_docu/api/notifications.rst @@ -13,7 +13,8 @@ models =========== .. autoclass:: allianceauth.notifications.models.Notification - :members: Level, mark_viewed, set_level + :members: + :exclude-members: DoesNotExist, MultipleObjectsReturned, save managers =========== diff --git a/docs/requirements.txt b/docs/requirements.txt index 8b49539b..a804dcf2 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -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