From 238a878e9628dbeebc6e776eff3b7d6a5586d6ce Mon Sep 17 00:00:00 2001
From: gubaidulinvadim <gubaidulinvadim@gmail.com>
Date: Mon, 15 Jul 2024 17:20:22 +0200
Subject: [PATCH] changed documentation generation options
---
docs/source/conf.py | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 10f665e..ccc4063 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -39,7 +39,14 @@ extensions = [
'sphinx.ext.viewcode',
'myst_parser'
]
-
+autodoc_default_options = {
+ 'member-order': 'bysource', # Keep the order of members as they appear in the source code
+ 'undoc-members': True, # Do not show undocumented members
+ 'private-members': True, # Do not show private members
+ 'special-members': '__init__', # Document __init__ method
+ 'show-inheritance': False, # Do not show base classes
+}
+add_module_names = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
--
GitLab