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

2025-07-09 04:20:17 +02:00 · 2022-06-27 13:41:15 +02:00 · 2022-06-27 13:41:15 +02:00 · 091a2637ea
commit 091a2637ea
parent 113977b19f
4 changed files with 6 additions and 3 deletions
--- 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.
--- 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
--- 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
 ===========
--- 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