pst-notebooks/conf.py at main · pydy/pst-notebooks · 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
import os
import multiprocessing

# 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 = "Peter's Mechanics Examples"
copyright = '2025, Peter Stahlecker'
author = 'Peter Stahlecker'

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

extensions = [
    'sphinx.ext.mathjax',
    'sphinx_gallery.gen_gallery',
]

templates_path = ['_templates']
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'gallery']

# -- Sphinx Gallery configuration --------------------------------------------
sphinx_gallery_conf = {
    'copyfile_regex': r'.*\.(npy|csv|yml|txt)',
    'examples_dirs': ['gallery'],
    'gallery_dirs': ['examples'],
    'matplotlib_animations': True,
    'parallel': multiprocessing.cpu_count(),
    'remove_config_comments': True,
}

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'alabaster'
html_static_path = ['_static']

html_theme_options = {
    'github_repo': 'pst-notebooks',
    'github_type': 'star',
    'github_user': 'pydy',
    'page_width': '1080px',  # 960 doesn't show 79 linewidth examples
}