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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# pydyf documentation build configuration file.
import pydyf
# 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.intersphinx',
'sphinx.ext.autosectionlabel']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'pydyf'
copyright = 'CourtBouillon and contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The full version, including alpha/beta/rc tags.
release = pydyf.__version__
# The short X.Y version.
version = '.'.join(release.split('.')[:2])
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'monokai'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'furo'
html_theme_options = {
'light_css_variables': {
'color-brand-primary': 'var(--red)',
'color-brand-content': 'var(--red)',
'color-brand-visited': 'var(--red)',
'font-stack': 'ClarityCity, sans-serif',
'font-stack--monospace': 'Inconsolata, monospace',
'font-stack--headings': 'Inconsolata, monospace',
},
'dark_css_variables': {
'color-brand-primary': 'var(--red)',
'color-brand-content': 'var(--red)',
'color-brand-visited': 'var(--red)',
},
'top_of_page_buttons': ['edit'],
'source_edit_link':
'https://github.com/CourtBouillon/pydyf/edit/main/docs/{filename}',
}
# Favicon URL
html_favicon = 'https://www.courtbouillon.org/static/images/favicon.png'
# 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 = []
# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_css_files = [
'https://www.courtbouillon.org/static/docs-furo.css',
]
# Output file base name for HTML help builder.
htmlhelp_basename = 'pydyf2doc'
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pydyf', 'pydyf Documentation',
['CourtBouillon and contributors'], 1)
]
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'pydyf', 'pydyf Documentation',
'CourtBouillon', 'pydyf',
'A low-level PDF creator',
'Miscellaneous'),
]
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
}
|
