XRPUsersGuide/conf.py at main · Open-STEM/XRPUsersGuide · 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
# 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

version: 2

project = 'XRP'
copyright = '2023, WPI'
author = 'WPI'
release = '2023.0'

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

extensions = [
    'sphinx_tabs.tabs',
    "sphinx_design",
    "sphinxcontrib.youtube",
    "sphinxcontrib.video"
]

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

# -- Options for translation support -------------------------------------------

gettext_compact = False
locale_dirs = ["locales/"]
localization_languages = [
    "en",
    "es",
]

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

html_theme = "sphinx_rtd_theme"
html_static_path = ['_static']
master_doc = 'index'


def setup(app):
    import os, shutil

    def copy_local_static(app, exception):
        if exception is not None:
            return
        for src_rel in ['course/building_nano/_static']:
            src = os.path.join(app.confdir, src_rel)
            dst = os.path.join(app.outdir, src_rel)
            if os.path.isdir(src):
                shutil.copytree(src, dst, dirs_exist_ok=True)

    app.connect('build-finished', copy_local_static)