epics-docs/conf.py at master · stephane-cea/epics-docs · 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config


# -- Path setup --------------------------------------------------------------

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- Project information -----------------------------------------------------

project = 'EPICS Documentation'
copyright = '2019, EPICS Controls.'
author = 'EPICS'


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

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
    'hoverxref.extension',
    'sphinx.ext.intersphinx',
    'sphinx.ext.mathjax',
    "sphinx_reredirects",
    # Markdown parser
    'myst_parser',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.*']

# Intersphinx links to subprojects
intersphinx_mapping = {
    'how-tos': ('https://docs.epics-controls.org/projects/how-tos/en/latest', None),
}
hoverxref_intersphinx = [
    'how-tos',
]
hoverxref_intersphinx_types = {
    'how-tos': 'modal',
}

# Enabled Markdown extensions.
# See here for what they do:
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = [
    "amsmath",
    "colon_fence",
    "deflist",
    "dollarmath",
    "fieldlist",
    "html_image",
    "replacements",
    "smartquotes",
    "strikethrough",
    "tasklist",
]

# Allows auto-generated header anchors:
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#auto-generated-header-anchors
myst_heading_anchors = 4


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

html_css_files = [
    'css/custom.css',
]

master_doc = 'index'

html_theme_options = {
    'logo_only': True,
}

# -- Redirections specifications ---------------------------------------------

# Specify redirections from the <docs.epics-controls.org> architecture
# (before 08/2023 EPICS documentathon), to the new <docs.epics-controls.org>
# (after 08/2023 EPICS documentathon).
# Also see https://documatt.gitlab.io/sphinx-reredirects/usage.html
redirects = {
    "guides/EPICS_Intro": "../getting-started/EPICS_Intro.html",

    "guides/EPICS_Process_Database_Concepts":
        "../process-database/EPICS_Process_Database_Concepts.html",

    "specs/specs":
        "../index.html",

    "specs/ca_protocol":
        "../internal/ca_protocol.html",

    "specs/Normative-Types-Specification":
        "../pv-access/Normative-Types-Specification.html",

    "specs/IOCInit":
        "../internal/IOCInit.html",

    "appdevguide/EPICSBuildFacility":
        "../build-system/specifications.html",

    "specs/EPICSBuildFacility":
        "../build-system/specifications.html",

    "software/base":
        "../index.html",

    "software/HowToWorkWithTheEpicsRepository":
        "../contributing/HowToWorkWithTheEpicsRepository.html",

    #"appdevguide/*": "appdevguide/*",
}
html_logo = "images/EPICS_green_logo.svg"