tidy up config

tkknight · Dec 29, 2023 · 320b815 · 320b815
1 parent 7546846
commit 320b815
Showing 1 changed file with 9 additions and 18 deletions.
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -193,31 +193,22 @@ def _dotv(version):
 # See https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
 todo_include_todos = True
 
-# api generation configuration
-autodoc_member_order = "alphabetical"
-
-# The supported options are 
-#    'members', 'member-order', 'undoc-members', 
-#    'private-members', 'special-members', 'inherited-members', 
-#    'show-inheritance', 'ignore-module-all', 'imported-members',
-#    'exclude-members', 'class-doc-from' and 'no-value'.
-#autodoc_default_flags = ["show-inheritance"]
+# sphinx.ext.autodocconfiguration ---------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
 autodoc_default_options = {
-    'members': True,
-    'member-order': "alphabetical",
-    'undoc-members': True,
-    'special-members': True,
-    'inherited-members': True,
-    'imported-members': True,
-    'show-inheritance': True,
+    "members": True,
+    "member-order": "alphabetical",
+    "undoc-members": True,
+    "private-members" : False,
+    "special-members": False,
+    "inherited-members": True,
+    "show-inheritance": True,
 }
 
-
 # https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_typehints
 autodoc_typehints = "none"
 autosummary_generate = True
 autosummary_imported_members = True
-autopackage_name = ["iris"]
 autoclass_content = "both"
 modindex_common_prefix = ["iris"]