conf.py 3.71 KB
Newer Older
Rahix's avatar
Rahix committed
1
2
3
4
5
6
7
8
9
10
11
import os
import subprocess
import sys
import time
import sphinx.util.logging

# 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.
#
sys.path.insert(0, os.path.abspath("../pycardium/modules/py"))
ch3's avatar
ch3 committed
12
sys.path.insert(0, os.path.abspath("./"))
Rahix's avatar
Rahix committed
13
14
15
16
17
18
19
20
21
22

logger = sphinx.util.logging.getLogger("card10/conf.py")


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

project = "card10-firmware"
copyright = "2019"

# The full version, including alpha/beta/rc tags
Rahix's avatar
Rahix committed
23
24
25
release = (
    subprocess.check_output(["git", "describe", "--long", "--always"]).decode().strip()
)
Rahix's avatar
Rahix committed
26
27
28
29
30
31
32
33
34
35
36
37
38
39
release += "<br />"
release += time.strftime("%F %R")
version = release


# -- 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 = [
    "sphinx.ext.autodoc",
    "sphinx.ext.viewcode",
    "sphinx.ext.ifconfig",
Rahix's avatar
Rahix committed
40
    "sphinx.ext.todo",
Rahix's avatar
Rahix committed
41
42
]

Rahix's avatar
Rahix committed
43
44
todo_include_todos = True

Rahix's avatar
Rahix committed
45
46
47
# 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.
ch3's avatar
ch3 committed
48
exclude_patterns = ["output", "Thumbs.db", ".DS_Store", "hawkmoth"]
Rahix's avatar
Rahix committed
49
50
51
52
53
54
55
56
57

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

# The Read the Docs theme is available from
# - https://github.com/snide/sphinx_rtd_theme
# - https://pypi.python.org/pypi/sphinx_rtd_theme
# - python-sphinx-rtd-theme package (on Debian)
try:
    import sphinx_rtd_theme
Rahix's avatar
Rahix committed
58

Rahix's avatar
Rahix committed
59
60
61
62
    html_theme = "sphinx_rtd_theme"
    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    pygments_style = "monokai"
except ImportError:
Rahix's avatar
Rahix committed
63
64
65
    logger.warning(
        'The Sphinx "sphinx_rtd_theme" HTML theme was not found. Make sure you have the theme installed to produce pretty HTML output. Falling back to the default theme.'
    )
Rahix's avatar
Rahix committed
66
67
68
69
70
71


# 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"]
Rahix's avatar
Rahix committed
72
73

# Theme Options
Rahix's avatar
Rahix committed
74
html_theme_options = {"style_external_links": True}
Rahix's avatar
Rahix committed
75
76
77
78
79
80
81
82
83
84
85
86

# Show "Edit on GitLab" links
html_show_sourcelink = False
html_context = {
    "display_gitlab": True,
    "gitlab_host": "git.card10.badge.events.ccc.de",
    "gitlab_user": "card10",
    "gitlab_repo": "firmware",
    "gitlab_version": "master/",
    "conf_py_path": "Documentation/",
    "theme_vcs_pageview_mode": "edit",
}
Rahix's avatar
Rahix committed
87
88
89
# }}}

# -- Options for Auto-Doc ---------------------------------------------------- {{{
Rahix's avatar
Rahix committed
90
autodoc_mock_imports = [
Rahix's avatar
Rahix committed
91
92
    "buttons",
    "interrupt",
93
    "sys_bme680",
94
    "sys_bhi160",
Rahix's avatar
Rahix committed
95
96
    "sys_display",
    "sys_leds",
Rahix's avatar
Rahix committed
97
    "sys_max30001",
Rahix's avatar
Rahix committed
98
99
100
101
    "ucollections",
    "urandom",
    "utime",
]
Rahix's avatar
Rahix committed
102
103
104
105
106
107
108
109
110

autodoc_member_order = "bysource"
# }}}

# -- Options for Hawkmoth ---------------------------------------------------- {{{
has_hawkmoth = False
try:
    # Attempt importing hawkmoth
    import hawkmoth  # noqa: F401
Rahix's avatar
Rahix committed
111

Rahix's avatar
Rahix committed
112
113
114
    extensions.append("hawkmoth")

    cautodoc_root = os.path.abspath("..")
Rahix's avatar
Rahix committed
115
    cautodoc_clang = "-D__SPHINX_DOC"
Rahix's avatar
Rahix committed
116
    has_hawkmoth = True
ch3's avatar
ch3 committed
117
118
except ImportError as e:
    if e.name == "clang":
Rahix's avatar
Rahix committed
119
120
121
        logger.warning(
            "hawkmoth requires the clang python module.  Documentation for Epicardium API will not be generated."
        )
Rahix's avatar
Rahix committed
122
123
124
125
126
127
# }}}


# -- Sphinx Setup ------------------------------------------------------------
def setup(app):
    app.add_config_value("has_hawkmoth", has_hawkmoth, "")