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
|
from pathlib import Path
# -- Project information -----------------------------------------------------
project = '@PROJECT_NAME@'
copyright = '2021, @PROJECT_NAME@ committers'
author = '@PROJECT_NAME@ committers'
# The short X.Y version
version = '@PROJECT_VERSION_MAJOR@.@PROJECT_VERSION_MINOR@.@PROJECT_VERSION_PATCH@'
# The full version, including alpha/beta/rc tags
release = '@PROJECT_VERSION@'
# -- General configuration ---------------------------------------------------
extensions = [
'breathe',
'sphinx.ext.intersphinx',
"sphinx.ext.viewcode",
"sphinx.ext.autosummary"
]
templates_path = ['_templates']
language = 'en'
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
try:
import piccolo_theme
extensions.append('piccolo_theme')
html_theme = 'piccolo_theme'
except ImportError:
import warnings
warnings.warn("piccolo_theme is not installed. Falling back to alabaster.")
html_theme = 'alabaster'
html_static_path = ['_static']
html_css_files = ['/_static/style.css']
autosummary_generate=True
# Tell sphinx what the primary language being documented is.
primary_domain = 'c'
# Tell sphinx what the pygments highlight language should be.
highlight_language = 'c'
breathe_domain_by_extension = { "h" : "c" , "c" : "c"}
breathe_show_define_initializer = True
breathe_show_include = True
|
