python_library_examples/conf.py at main · krother/python_library_examples · 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
# 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

project = 'Python Library Examples'
copyright = '2025, Kristian Rother'
author = 'Kristian Rother'
release = '1.0'
html_title = f"{project}"

# -- General configuration ---------------------------------------------------

extensions = [
    'sphinx_design',
    'sphinx_copybutton',
    'sphinx.ext.todo',
    'myst_parser',
    #'sphinxcontrib.cairosvgconverter',
    ]

templates_path = ['_templates']
exclude_patterns = ['.venv', '_build', 'Thumbs.db', '.DS_Store', 'learning_goals.md', 'README.md',
                    'TODO.md', 'CLAUDE.md', '.claude']

language = 'en'

# -- 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_logo = "_static/academis_logo.png"
html_favicon = "_static/favicon.ico"


html_css_files = [
    "academis.css",
]

html_theme_options = {
    "source_repository": "https://github.com/krother/python_library_examples",
    "source_branch": "main",
    "source_directory": "",
}

# ---- Options for PDF output ----

latex_elements = {
    'preamble': r"\linespread{1.25}",
}