Debian Codegraph @

docs/conf.py

raw ◀ ▶
Source reconstructed at patch state 0 of 1 — not the installed (fully patched) source.
1 Debian patch touch this file
1 # Configuration file for the Sphinx documentation builder.
2 #
3 # This file does only contain a selection of the most common options. For a
4 # full list see the documentation:
5 # http://www.sphinx-doc.org/en/master/config
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 sys
14 from pathlib import Path
15
16 sys.path.insert(0, str(Path(__file__).parent.parent))
17
18 from url_matcher import __version__
19
20 # -- Project information -----------------------------------------------------
21
22 project = "url-matcher"
23 copyright = "2021, Zyte"
24 author = "Zyte"
25
26 # The short X.Y version
27 version = ""
28 # The full version, including alpha/beta/rc tags
29 release = __version__.__version__
30
31
32 # -- General configuration ---------------------------------------------------
33
34 # If your documentation needs a minimal Sphinx version, state it here.
35 #
36 # needs_sphinx = '1.0'
37
38 # Add any Sphinx extension module names here, as strings. They can be
39 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40 # ones.
41 extensions = [
42 "sphinx.ext.autodoc",
43 "sphinx.ext.intersphinx",
44 "sphinx.ext.ifconfig",
45 "sphinx.ext.viewcode",
46 "sphinx.ext.githubpages",
47 "sphinx.ext.autosummary",
48 ]
49
50 # Add any paths that contain templates here, relative to this directory.
51 templates_path = ["_templates"]
52
53 # The suffix(es) of source filenames.
54 # You can specify multiple suffix as a list of string:
55 #
56 # source_suffix = ['.rst', '.md']
57 source_suffix = {".rst": "restructuredtext"}
58
59 # The master toctree document.
60 master_doc = "index"
61
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
64 #
65 # This is also used if you do content translation via gettext catalogs.
66 # Usually you set "language" from the command line for these cases.
67 language = "en"
68
69 # List of patterns, relative to source directory, that match files and
70 # directories to ignore when looking for source files.
71 # This pattern also affects html_static_path and html_extra_path.
72 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
73
74 # The name of the Pygments (syntax highlighting) style to use.
75 pygments_style = None
76
77
78 # -- Options for HTML output -------------------------------------------------
79
80 # The theme to use for HTML and HTML Help pages. See the documentation for
81 # a list of builtin themes.
82 #
83 html_theme = "sphinx_rtd_theme"
84
85 # Theme options are theme-specific and customize the look and feel of a theme
86 # further. For a list of options available for each theme, see the
87 # documentation.
88 #
89 # html_theme_options = {}
90
91 # Add any paths that contain custom static files (such as style sheets) here,
92 # relative to this directory. They are copied after the builtin static files,
93 # so a file named "default.css" will overwrite the builtin "default.css".
94 # html_static_path = ['_static']
95
96 # Custom sidebar templates, must be a dictionary that maps document names
97 # to template names.
98 #
99 # The default sidebars (for documents that don't match any pattern) are
100 # defined by theme itself. Builtin themes are using these templates by
101 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
102 # 'searchbox.html']``.
103 #
104 # html_sidebars = {}
105
106
107 # -- Options for HTMLHelp output ---------------------------------------------
108
109 # Output file base name for HTML help builder.
110 htmlhelp_basename = "url-matcher-doc"
111
112
113 # -- Options for LaTeX output ------------------------------------------------
114
115 latex_elements: dict = {
116 # The paper size ('letterpaper' or 'a4paper').
117 #
118 # 'papersize': 'letterpaper',
119 # The font size ('10pt', '11pt' or '12pt').
120 #
121 # 'pointsize': '10pt',
122 # Additional stuff for the LaTeX preamble.
123 #
124 # 'preamble': '',
125 # Latex figure (float) alignment
126 #
127 # 'figure_align': 'htbp',
128 }
129
130 # Grouping the document tree into LaTeX files. List of tuples
131 # (source start file, target name, title,
132 # author, documentclass [howto, manual, or own class]).
133 latex_documents = [
134 (
135 master_doc,
136 "url-matcher.tex",
137 "url-matcher Documentation",
138 "Zyte",
139 "manual",
140 ),
141 ]
142
143
144 # -- Options for manual page output ------------------------------------------
145
146 # One entry per manual page. List of tuples
147 # (source start file, name, description, authors, manual section).
148 man_pages = [(master_doc, "url-matcher", "url-matcher Documentation", [author], 1)]
149
150
151 # -- Options for Texinfo output ----------------------------------------------
152
153 # Grouping the document tree into Texinfo files. List of tuples
154 # (source start file, target name, title, author,
155 # dir menu entry, description, category)
156 texinfo_documents = [
157 (
158 master_doc,
159 "url-matcher",
160 "url-matcher Documentation",
161 author,
162 "url-matcher",
163 "URL matching rules library to connect URLs with resources",
164 "Miscellaneous",
165 ),
166 ]
167
168
169 # -- Options for Epub output -------------------------------------------------
170
171 # Bibliographic Dublin Core info.
172 epub_title = project
173
174 # The unique identifier of the text. This can be a ISBN number
175 # or the project homepage.
176 #
177 # epub_identifier = ''
178
179 # A unique identification for the text.
180 #
181 # epub_uid = ''
182
183 # A list of files that should not be packed into the epub file.
184 epub_exclude_files = ["search.html"]
185
186
187 # -- Extension configuration -------------------------------------------------
188
189 # -- Options for intersphinx extension ---------------------------------------
190 intersphinx_mapping = {
191 "python": (
192 "https://docs.python.org/3",
193 None,
194 )
195 }
196
197 autodoc_default_options = {
198 "special-members": "__init__,__call__",
199 "undoc-members": True,
200 }
201
202 add_module_names = False
203 autosummary_generate = True