probequest/docs/conf.py at develop · SkypLabs/probequest · 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
# 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

# pylint: skip-file

from datetime import datetime

from probequest import __version__ as VERSION

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "ProbeQuest"
copyright = f"2017-{datetime.now().year}, Paul-Emmanuel Raoul"
author = "Paul-Emmanuel Raoul"

release = VERSION

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

extensions = [
    "sphinx.ext.autodoc",
    "sphinx.ext.todo",
    "sphinx.ext.viewcode",
    "sphinxarg.ext",
    "sphinxcontrib.seqdiag",
]

templates_path = ["_templates"]

master_doc = "index"

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# -- 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"]

html_context = {
    "conf_py_path": "/docs/",
    "display_github": True,
    "github_user": "SkypLabs",
    "github_repo": "probequest",
    "github_version": "develop",
    "plausible_domain": "probequest.skyplabs.net",
}

# -- Extension configuration -------------------------------------------------

# -- Options for todo extension ----------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html

todo_include_todos = True

# -- Options for sphinxcontrib-seqdiag extension -----------------------------
# http://blockdiag.com/en/seqdiag/sphinxcontrib.html

seqdiag_fontpath = "/usr/share/fonts/truetype/ipafont/ipagp.ttf"