crinit/conf.py at main · Elektrobit/crinit · 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
# 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 = 'crinit'
copyright = '2023, emlix GmbH/Elektrobit Automotive GmbH'
author = 'anton.hillebrand@emlix.com'

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

extensions = [
    'myst_parser',
    'sphinx.ext.autodoc',
    'sphinx.ext.doctest',
    'sphinxcontrib.programoutput',
    'sphinx_favicon',

    # copy button on code blocks in HTML doc
    'sphinx_copybutton',

    # for code documentation & referencing
    'sphinx.ext.viewcode',
    'sphinx.ext.napoleon',
    'sphinx_c_autodoc',
    'sphinx_c_autodoc.napoleon',
    'sphinx_c_autodoc.viewcode',
    'sphinx.ext.githubpages',
]

templates_path = ['doc/_templates']
exclude_patterns = [
    'deps/*',
    'packaging/**',
    "build/**/README.md",
    "build/*/debbuild/**",
    "result/**",
    "build/*/doc/doxygen/doc/adr/**",
    "build/*/doc/sphinx/**",
    "build/*-Debug/**",
    "test/*",
]
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

language = 'en'

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

html_theme = 'alabaster'
html_static_path = ['images', 'doc/api']
html_logo = 'images/crinit_logo_blk.svg'

favicons = [
    "favicon_16x16.png",
    "favicon_32x32.png",
]

master_doc = "index"

# c-autodoc
c_autodoc_roots = [
    './src/',
    './inc/',
]

set_type_checking_flag = True
myst_footnote_transition = False
myst_heading_anchors = 4