fix(entities): fix broken core documentation (#311)

openfisca · Oct 1, 2024 · c434a5b · c434a5b
2 parents 07639df + c1fd8e5
commit c434a5b
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 14 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .DS_Store
+.idea
 .python-version
 .venv
 build/*
diff --git a/source/conf.py b/source/conf.py
@@ -69,10 +69,14 @@
     'ignore-module-all': True
 }
 
+napoleon_custom_sections = [('Returns', 'params_style')]
+
+
 def missing_reference(app, env, node, contnode):
     if node['reftype'] == 'class' and node['reftarget'].startswith('nptyping'):
         return contnode
 
+
 def setup(app):
     app.add_config_value('recommonmark_config', {
         'url_resolver': lambda url: url.replace('.md', '.html'),

diff --git a/source/openfisca-python-api/commons.rst b/source/openfisca-python-api/commons.rst
@@ -4,4 +4,4 @@ Commons
 
 .. automodule:: openfisca_core.commons
     :members:
-    :special-members: __call__
+    :imported-members:
diff --git a/source/openfisca-python-api/entities.rst b/source/openfisca-python-api/entities.rst
@@ -2,17 +2,7 @@
 Entities
 ========
 
-.. module:: openfisca_core.entities
-
-.. autoclass:: Role
-    :noindex:
-    :members:
-
-.. autoclass:: Entity
-    :members:
-
-.. autoclass:: GroupEntity
-    :members:
-
-.. automodule:: openfisca_core.entities.helpers
+.. automodule:: openfisca_core.entities
     :members:
+    :imported-members:
+    :inherited-members: