formatted

Author: jhavl

docs/source/conf.py

@@ -15,18 +15,18 @@
 # Defined relative to configuration directory which is where this file conf.py lives
 sys.path.append(os.path.abspath("exts"))
 
-# -------- Project information ----------------------------------------------------------
+# -------- Project information -------------------------------------------------------#
 
 project = "Robotics Toolbox for Python"
-copyright = "2022, Jesse Haviland and Peter Corke"
+copyright = "2023, Jesse Haviland and Peter Corke"
 author = "Jesse Haviland and Peter Corke"
 
 # Parse version number out of setup.py
 with open("../../setup.py", encoding="utf-8") as f:
     setup_py = f.read()
     m = re.search(r"version='([0-9\.]*)',", setup_py, re.MULTILINE)
 
-# -------- General configuration --------------------------------------------------------
+# -------- General configuration -----------------------------------------------------#
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -74,7 +74,7 @@
 ANSITable._color = False
 """
 
-# -------- Options for HTML output ------------------------------------------------------
+# -------- Options for HTML output ---------------------------------------------------#
 
 html_theme = "sphinx_rtd_theme"
 
@@ -102,7 +102,7 @@
 ]
 default_role = "py:obj"
 
-# -------- Options for LaTeX/PDF output -------------------------------------------------
+# -------- Options for LaTeX/PDF output ----------------------------------------------#
 
 latex_engine = "xelatex"
 
@@ -114,7 +114,8 @@
 }
 
 # Use RVC book notation for maths
-# see https://stackoverflow.com/questions/9728292/creating-latex-math-macros-within-sphinx
+# see
+# https://stackoverflow.com/questions/9728292/creating-latex-math-macros-within-sphinx
 mathjax3_config = {
     "tex": {
         "macros": {
@@ -151,7 +152,7 @@
     }
 }
 
-# -------- Options InterSphinx ----------------------------------------------------------
+# -------- Options InterSphinx -------------------------------------------------------#
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
@@ -161,15 +162,15 @@
 }
 
 
-# -------- Options Napoleon -------------------------------------------------------------
+# -------- Options Napoleon ----------------------------------------------------------#
 
 # Include special members (like __membername__) with docstrings in
 # the documentation
 napoleon_include_special_with_doc = True
 
 napoleon_custom_sections = ["Synopsis"]
 
-# -------- Options AutoSummary ----------------------------------------------------------
+# -------- Options AutoSummary -------------------------------------------------------#
 
 # autodoc_default_flags = ["members"]
 autosummary_generate = True