pypsa-usa/docs/source/conf.py at 460bbde1adebee58f90c082dde4bfcf9cd0ce206 · PyPSA/pypsa-usa · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
"""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
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information


import os
import sys

project = "pypsa-usa"
copyright = "2024, Kamran Tehranchi, Trevor Barnes"
author = "Kamran Tehranchi, Trevor Barnes"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration


# 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.
sys.path.insert(0, os.path.abspath("../../workflow/scripts"))

extensions = [
    # 'sphinx.ext.autodoc',
    # 'sphinx.ext.autosummary',
    "myst_parser",
    # "sphinx.ext.autosectionlabel",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    "sphinx.ext.mathjax",
    "sphinx.ext.napoleon",
    "sphinx.ext.graphviz",
    # "sphinxcontrib.bibtex",
    # 'sphinx.ext.pngmath',
    # 'sphinxcontrib.tikz',
    # 'rinoh.frontend.sphinx',
    "sphinx.ext.imgconverter",  # for SVG conversion
]
myst_enable_extensions = ["html_image", "colon_fence", "amsmath"]
myst_heading_anchors = 3

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 = "sphinx_book_theme"
html_static_path = ["_static"]

html_theme_options = {
    "repository_url": "https://github.com/pypsa/pypsa-usa",
    "use_repository_button": True,
    "show_navbar_depth": 1,
}

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = "PyPSA-USA"

# A shorter title for the navigation bar.  Default is the same as html_title.
html_short_title = "PyPSA-USA"

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "./_static/pypsa-logo.png"