1
|
|
|
# Configuration file for the Sphinx documentation builder. |
2
|
|
|
# |
3
|
|
|
# This file only contains a selection of the most common options. For a full |
4
|
|
|
# list see the documentation: |
5
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html |
6
|
|
|
|
7
|
|
|
# -- Path setup -------------------------------------------------------------- |
8
|
|
|
|
9
|
|
|
# If extensions (or modules to document with autodoc) are in another directory, |
10
|
|
|
# add these directories to sys.path here. If the directory is relative to the |
11
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here. |
12
|
|
|
# |
13
|
|
|
import os |
14
|
|
|
import sys |
15
|
|
|
|
16
|
|
|
sys.path.insert(0, os.path.join( |
17
|
|
|
os.path.dirname(os.path.abspath(__file__)), |
18
|
|
|
os.pardir, |
19
|
|
|
os.pardir, |
20
|
|
|
'sutime', |
21
|
|
|
'sutime.py', |
22
|
|
|
)) |
23
|
|
|
|
24
|
|
|
|
25
|
|
|
# -- Project information ----------------------------------------------------- |
26
|
|
|
|
27
|
|
|
project = 'python-sutime' |
28
|
|
|
author = 'Frank Blechschmidt' |
29
|
|
|
|
30
|
|
|
# The full version, including alpha/beta/rc tags |
31
|
|
|
release = '1.0.1' |
32
|
|
|
|
33
|
|
|
|
34
|
|
|
# -- General configuration --------------------------------------------------- |
35
|
|
|
|
36
|
|
|
# Add any Sphinx extension module names here, as strings. They can be |
37
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
38
|
|
|
# ones. |
39
|
|
|
extensions = [ |
40
|
|
|
'sphinx.ext.autodoc', |
41
|
|
|
'sphinx.ext.coverage', |
42
|
|
|
'sphinx.ext.napoleon', |
43
|
|
|
] |
44
|
|
|
|
45
|
|
|
# Add any paths that contain templates here, relative to this directory. |
46
|
|
|
templates_path = ['_templates'] |
47
|
|
|
|
48
|
|
|
# List of patterns, relative to source directory, that match files and |
49
|
|
|
# directories to ignore when looking for source files. |
50
|
|
|
# This pattern also affects html_static_path and html_extra_path. |
51
|
|
|
exclude_patterns = [] |
52
|
|
|
|
53
|
|
|
|
54
|
|
|
# -- Options for HTML output ------------------------------------------------- |
55
|
|
|
|
56
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
57
|
|
|
# a list of builtin themes. |
58
|
|
|
# |
59
|
|
|
html_theme = 'sphinx_typlog_theme' |
60
|
|
|
html_theme_options = { |
61
|
|
|
'github_user': 'FraBle', |
62
|
|
|
'github_repo': 'python-sutime', |
63
|
|
|
} |
64
|
|
|
html_sidebars = { |
65
|
|
|
'**': [ |
66
|
|
|
'searchbox.html', |
67
|
|
|
'github.html', |
68
|
|
|
], |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
72
|
|
|
# relative to this directory. They are copied after the builtin static files, |
73
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
74
|
|
|
html_static_path = ['_static'] |
75
|
|
|
html_show_copyright = False |
76
|
|
|
html_show_sphinx = False |
77
|
|
|
|
78
|
|
|
autoclass_content = 'both' |
79
|
|
|
|