Update conf.py

docs/source/conf.py

@@ -4,30 +4,23 @@
 # list see the documentation:
 # http://www.sphinx-doc.org/en/master/config
 
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-
-# -- Project information -----------------------------------------------------
-
-project = 'pyEPR'
-copyright = '2020, Zlatko Minev, Zaki Leghtas, and the pyEPR Team'
-author = 'Zlatko Minev, Zaki Leghtas, and the pyEPR Team'
+# -- Path information -----------------------------------------------------
 
 import sys
 import os
+
 sys.path.insert(0, os.path.abspath("../../pyEPR"))
 print(sys.path)
 
+# -- Project information -----------------------------------------------------
+
+project = "pyEPR"
+copyright = "2017-2025, Zlatko Minev, Zaki Leghtas, and the pyEPR Team"
+author = "Zlatko Minev, Zaki Leghtas, and the pyEPR Team"
+
 # The full version, including alpha/beta/rc tags
 import pyEPR
+
 version = pyEPR.__version__
 release = version
 
@@ -39,27 +32,25 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-	"sphinx.ext.intersphinx",
-	"sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
-    'sphinx.ext.coverage',
-    'sphinx.ext.napoleon', #  parse both NumPy and Google style docstrings
-    'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages',
+    "sphinx.ext.coverage",
+    "sphinx.ext.napoleon",  #  parse both NumPy and Google style docstrings
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
     "sphinx.ext.mathjax",
     "sphinx_rtd_theme",
-    #'sphinx_automodapi.automodapi',
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
     "matplotlib.sphinxext.plot_directive",
-    #'numpydoc'
 ]
 
 # https://github.com/readthedocs/readthedocs.org/issues/2569
-master_doc = 'index'
+master_doc = "index"
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -76,7 +67,7 @@
 show_authors = True
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 numpydoc_show_class_members = True
@@ -88,49 +79,49 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme =  'sphinx_rtd_theme' #'default' # 'sphinx_rtd_theme' #'alabaster' "sphinxdoc" 'classic'
+html_theme = "sphinx_rtd_theme"  #'default' # 'sphinx_rtd_theme' #'alabaster' "sphinxdoc" 'classic'
 if 0:
-	import os
-	on_rtd = os.environ.get('READTHEDOCS') == 'True'
-	if on_rtd:
-	    html_theme = 'default'
-	else:
-	    html_theme = 'nature'
+    import os
+
+    on_rtd = os.environ.get("READTHEDOCS") == "True"
+    if on_rtd:
+        html_theme = "default"
+    else:
+        html_theme = "nature"
 
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
-full_logo= True
-
+html_theme = "sphinx_rtd_theme"
+full_logo = True
 
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    'canonical_url': '',
+    "canonical_url": "",
     #'logo_only': False,
-    'display_version': True,
-    'prev_next_buttons_location': 'bottom',
-    'style_external_links': False,
+    "display_version": True,
+    "prev_next_buttons_location": "bottom",
+    "style_external_links": False,
     #'style_nav_header_background': 'white',
     # Toc options
-    'collapse_navigation': False,
-    'sticky_navigation': True,
-    'navigation_depth': 4,
-    'includehidden': True,
-    'titles_only': False
+    "collapse_navigation": False,
+    "sticky_navigation": True,
+    "navigation_depth": 4,
+    "includehidden": True,
+    "titles_only": False,
 }
 # Add any paths that contain custom themes here, relative to this directory.
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 
 # If false, no module index is generated.
@@ -139,14 +130,12 @@
 html_show_sourcelink = True
 
 # Sort members by type
-#autodoc_member_order = 'groupwise'
+# autodoc_member_order = 'groupwise'
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
 
-
-
 # -----------------------------------------------------------------------------
 # Autosummary
 # -----------------------------------------------------------------------------
@@ -156,31 +145,28 @@
 # -----------------------------------------------------------------------------
 # Autodoc
 # -----------------------------------------------------------------------------
-#The supported options are
+# The supported options are
 # 'members', 'member-order', 'undoc-members', 'private-members',
 # 'special-members', 'inherited-members', 'show-inheritance', 'ignore-module-all',
 # 'imported-members' and 'exclude-members'.
 autodoc_default_options = {
-    'inherited-members': None,
+    "inherited-members": None,
     #'member-order': 'bysource',
-    'member-order': 'alphabetical', #This value selects if automatically documented members are sorted alphabetical (value 'alphabetical'), by member type (value 'groupwise') or by source order (value 'bysource'). The default is alphabetical.
-    'undoc-members': True, # Members without docstrings will be left out, unless you give the undoc-members flag option:
-    'exclude-members': '__weakref__',
-    'show-inheritance' : True # , a list of base classes will be inserted just below the class signature (when used with automodule, this will be inserted for every class that is documented in the module).
+    "member-order": "alphabetical",  # This value selects if automatically documented members are sorted alphabetical (value 'alphabetical'), by member type (value 'groupwise') or by source order (value 'bysource'). The default is alphabetical.
+    "undoc-members": True,  # Members without docstrings will be left out, unless you give the undoc-members flag option:
+    "exclude-members": "__weakref__",
+    "show-inheritance": True,  # , a list of base classes will be inserted just below the class signature (when used with automodule, this will be inserted for every class that is documented in the module).
 }
 
 
-
 # If true, figures, tables and code-blocks are automatically numbered if they
 # have a caption.
 numfig = True
 
 # A dictionary mapping 'figure', 'table', 'code-block' and 'section' to
 # strings that are used for format of figure numbers. As a special character,
 # %s will be replaced to figure number.
-numfig_format = {
-    'table': 'Table %s'
-}
+numfig_format = {"table": "Table %s"}
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
@@ -194,7 +180,7 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'colorful'
+pygments_style = "colorful"
 
 # A boolean that decides whether module names are prepended to all object names
 # (for object types where a “module” of some kind is defined), e.g. for
@@ -205,4 +191,4 @@
 # (e.g., if this is set to ['foo.'], then foo.bar is shown under B, not F).
 # This can be handy if you document a project that consists of a single
 # package. Works only for the HTML builder currently.
-#modindex_common_prefix = ['pyEPR.']
+# modindex_common_prefix = ['pyEPR.']