spinx going book

docs/source/conf.py

@@ -15,30 +15,47 @@ release = '2.5.0'
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [#'myst_parser',
-              'sphinx.ext.autodoc',
-              'sphinx.ext.autosummary',
-              'sphinx.ext.linkcode',
-              'sphinx_mdinclude',
+                  'sphinx.ext.todo',
+                  'sphinx.ext.autodoc',
+                  'sphinx.ext.intersphinx',
+                  # 'sphinx.ext.autosummary',
+                  'sphinx.ext.linkcode',
+                  'sphinx_mdinclude',
               ]
 
 templates_path = ['_templates']
 exclude_patterns = ['marl_factory_grid.utils.proto', 'marl_factory_grid.utils.proto.fiksProto_pb2*']
 
+
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints = 'description'
+autodoc_inherit_docstrings = True
+autodoc_typehints_format = 'short'
+autodoc_default_options = {
+    'members': True,
+    # 'member-order': 'bysource',
+    'special-members': '__init__',
+    'undoc-members': True,
+    # 'exclude-members': '__weakref__',
+    'show-inheritance': True,
+}
+autosummary_generate = True
+add_module_names = False
+toc_object_entries = False
+modindex_common_prefix = ['marl_factory_grid.']
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here.
 from pathlib import Path
 import sys
 sys.path.insert(0, (Path(__file__).parents[2]).resolve().as_posix())
 sys.path.insert(0, (Path(__file__).parents[2] / 'marl_factory_grid').resolve().as_posix())
-import sphinx_pdj_theme
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-html_theme = 'alabaster'
-html_theme_path = [sphinx_pdj_theme.get_html_theme_path()]
-
-
-html_static_path = ['_static']
+html_theme = "sphinx_book_theme"  # 'alabaster'
+# html_static_path = ['_static']
 
 # In your configuration, you need to specify a linkcode_resolve function that returns an URL based on the object.
 # https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html
@@ -52,9 +69,4 @@ def linkcode_resolve(domain, info):
     filename = info['module'].replace('.', '/')
     return "https://github.com/illiumst/marl-factory-grid/%s.py" % filename
 
-
-autoclass_content = 'both'
-autosummary_generate = True
-add_module_names = False
-
-print(sys.executable)
+print(sys.executable)