From 8da341b7b8e9db3842fc3cce8f5d000d5d00fc9b Mon Sep 17 00:00:00 2001
From: MartinPdeS <Martin.Poinsinet.de.Sivry@gmail.com>
Date: Thu, 19 Dec 2024 14:38:21 +0100
Subject: [PATCH] update documentation formating

---
 docs/source/code/index.rst |  4 ++--
 docs/source/conf.py        | 30 ++++++++++++++++++++----------
 2 files changed, 22 insertions(+), 12 deletions(-)

diff --git a/docs/source/code/index.rst b/docs/source/code/index.rst
index acbffde49..51633da90 100644
--- a/docs/source/code/index.rst
+++ b/docs/source/code/index.rst
@@ -1,5 +1,5 @@
-Source Code Structures
-=======================
+API Reference
+=============
 
 This section provides an overview of the classes and components available in the PyMieSim package. Each component listed below inherits relevant attributes and methods, allowing users to build flexible and customizable scattering simulations.
 This overview serves as a guide for understanding how the package is organized and how its parts can be used to simulate different optical scattering scenarios.
diff --git a/docs/source/conf.py b/docs/source/conf.py
index e1e7ee13a..060ede53b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -52,6 +52,7 @@ def setup(app):
 ]
 
 autodoc_typehints = "description"
+autosummary_generate = True
 
 # Napoleon settings for docstrings
 napoleon_google_docstring = False
@@ -88,10 +89,11 @@ def reset_mpl(gallery_conf, fname):
 
 
 autodoc_default_options = {
-    'members': False,
+    "members": True,
+    "undoc-members": False,
+    "show-inheritance": True,
+    "exclude-members": "__annotations__",
     'members-order': 'bysource',
-    'undoc-members': False,
-    'show-inheritance': True,
 }
 
 autosectionlabel_prefix_document = True
@@ -109,12 +111,22 @@ def reset_mpl(gallery_conf, fname):
 
 exclude_trees = []
 # default_role = "autolink"
+show_authors = True
 pygments_style = "sphinx"
 
 # -- Sphinx-gallery configuration --------------------------------------------
 major, minor = version[:2]
 binder_branch = f"v{major}.{minor}.x"
 
+html_context = {
+    "github_url": "https://github.com", # or your GitHub Enterprise site
+    "github_user": package_name,
+    "github_repo": package_name,
+    "github_version": "master",
+    "doc_path": "doc/source",
+    "default_mode": "dark",
+}
+
 html_theme_options = dict()
 
 html_theme_options['logo'] = dict(text=package_name, image="_static/thumbnail.png")
@@ -122,11 +134,6 @@ def reset_mpl(gallery_conf, fname):
 
 html_theme_options.update({
     "icon_links": [
-        {
-            "name": "GitHub",
-            "url": f"https://github.com/MartinPdeS/{package_name}",
-            "icon": "fa-brands fa-github",
-        },
         {
             "name": "PyPI",
             "url": f"https://pypi.org/project/{package_name}/",
@@ -139,7 +146,7 @@ def reset_mpl(gallery_conf, fname):
         },
     ],
     "navbar_align": "left",
-    "navbar_end": ["version-switcher", "navbar-icon-links"],
+    "navbar_end": ["version-switcher", "theme-switcher", "navbar-icon-links"],
     "show_prev_next": False,
     "show_version_warning_banner": True,
     # Footer
@@ -186,4 +193,7 @@ def reset_mpl(gallery_conf, fname):
 html_css_files = ['default.css']
 epub_exclude_files = ['search.html']
 
-# -
+# Intersphinx to get NumPy, SciPy, and other targets
+intersphinx_mapping = {
+    'numpy': ('https://numpy.org/devdocs', None),
+}