linux-reference/conf.py at master · ramwin/linux-reference · 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
# 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='Linux Reference'
copyright='2024, Xiang Wang'
author='Xiang Wang'

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

extensions= [
"myst_parser",
"sphinx_design",
"sphinx.ext.todo",
"sphinx.ext.autodoc",
# "sphinxmermaid",
"sphinxcontrib.mermaid",
 ]

templates_path= ['_templates']
exclude_patterns= [
'_build',
'.DS_Store',
'.git',
'Thumbs.db',
"node_modules",
 ]

language='zh_CN'

# -- 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']
source_suffix= {
".rst": "restructuredtext",
".md": "markdown",
}
myst_heading_anchors=7
myst_enable_extensions= [
"attrs_inline", # 给元素添加属性,比如图片宽度
"colon_fence",
"strikethrough",
"tasklist",
]
html_css_files= [
"custom.css"
 ]
mermaid_version="11.9.0"
mermaid_use_local="/_static/node_modules/mermaid/dist/mermaid.esm.min.mjs"
mermaid_elk_use_local="/_static/node_modules/@mermaid-js/layout-elk/dist/mermaid-layout-elk.esm.min.mjs"
d3_use_local="/_static/node_modules/d3/dist/d3.min.js"
todo_include_todos=True
latex_use_xindy=True
smartquotes=True
suppress_warnings= [
"myst.header",
"myst.xref_missing",
"myst.not_included",
"toc.not_included",
]