# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
import pyspw
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Py-SPW'
copyright = '2023, Teleport'
author = 'Teleport'
release = pyspw.__version__
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
"sphinx.ext.autodoc",
]
templates_path = ['_templates']
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'furo'
html_static_path = ['_static']
html_sidebars = {
"**": [
"sidebar/scroll-start.html",
"sidebar/brand.html",
"sidebar/search.html",
"sidebar/navigation.html",
"sidebar/navigation.html",
"sidebar/ethical-ads.html",
"sidebar/scroll-end.html",
],
}
html_theme_options = {
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/teleportx/Py-SPW",
"html": """
""",
"class": "",
},
{
"name": "PyPi",
"url": "https://pypi.org/project/Py-SPW",
"html": """
""",
"class": "",
},
],
"source_repository": "https://github.com/teleportx/Py-SPW/",
"source_branch": "main",
"source_directory": "docs/",
}