diff --git a/python/docs/conf.py b/python/docs/conf.py index d725a025..4990fa4c 100644 --- a/python/docs/conf.py +++ b/python/docs/conf.py @@ -10,16 +10,11 @@ # Copyright 2024 Nervosys, LLC # -# -- Project information ----------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information - - # -- 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 @@ -28,27 +23,27 @@ import sphinx_immaterial from autonomysim import __version__ + # -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = "AutonomySim" copyright = 'Copyright © 2024 Nervosys, LLC' author = "Nervosys" -# The short X.Y version -version = __version__ -# The full version, including alpha/beta/rc tags -release = version - +# short X.Y version +# version = __version__ +version = "" +# full version, including alpha/beta/rc tags +# release = version +release = "" # -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration # If your documentation needs a minimal Sphinx version, state it here. -# # needs_sphinx = '1.0' -# -- General configuration --------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration - # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. @@ -76,7 +71,6 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: -# # source_suffix = ['.rst', '.md'] source_suffix = ".rst" @@ -84,10 +78,9 @@ master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. +# for a list of supported languages. This is also used if you do content +# translation via gettext catalogs. Usually you set "language" from the +# command line for these cases. language = "en" # List of patterns, relative to source directory, that match files and @@ -106,14 +99,12 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -# # html_theme = 'alabaster' html_theme = "sphinx_immaterial" # 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 = {} html_theme_options = { "site_url": "https://nervosys.github.io/AutonomySim", @@ -126,7 +117,7 @@ "version_info": [ { "version": "https://nervosys.github.io/AutonomySim", - "title": "Github Pages", + "title": "Main", "aliases": [], }, ], @@ -212,12 +203,10 @@ # Custom sidebar templates, must be a dictionary that maps document names # to template names. -# # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. -# # html_sidebars = {} @@ -229,6 +218,7 @@ # -- Options for LaTeX output ------------------------------------------------ +# Elements latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # @@ -290,11 +280,9 @@ # The unique identifier of the text. This can be a ISBN number # or the project homepage. -# # epub_identifier = '' # A unique identification for the text. -# # epub_uid = '' # A list of files that should not be packed into the epub file.