Mathis/allianceauth
1
0
Fork 0
mirror of https://gitlab.com/allianceauth/allianceauth.git synced 2025-07-09 12:30:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add extension to improve autodocs for Django models & enable source links

Browse Source
This commit is contained in:
ErikKalkoken 2022-06-27 13:41:15 +02:00
parent 113977b19f
commit 091a2637ea
4 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/conf.py
View File

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

3
docs/development/tech_docu/api/eveonline.rst
View File

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

3
docs/development/tech_docu/api/notifications.rst
View File

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

1
docs/requirements.txt
View File

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