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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
# Copyright 2014-2024 by Falcon Contributors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# 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
import datetime
import multiprocessing
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
import falcon # noqa: E402
# -- Build tweaks -------------------------------------------------------------
# NOTE(kgriffs): Work around the change in Python 3.8 that breaks sphinx
# on macOS. See also:
#
# * https://github.com/sphinx-doc/sphinx/issues/6803
# * https://docs.python.org/3/library/multiprocessing.html#contexts-and-start-methods
#
if not sys.platform.startswith('win'):
multiprocessing.set_start_method('fork')
# _on_rtd is whether we are on readthedocs.org
# _on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# Used to alter sphinx configuration for the Dash documentation build
_dash_build = os.environ.get('DASHBUILD', False) == 'True'
# 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('..'))
sys.path.insert(0, os.path.abspath('.'))
# -- Project information ------------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
_version_components = falcon.__version__.split('.')
_prerelease_version = any(
not component.isdigit() and not component.startswith('post')
for component in _version_components
)
project = 'Falcon'
copyright = '{year} Falcon Contributors'.format(year=datetime.datetime.now().year)
author = 'Kurt Griffiths et al.'
version = '.'.join(_version_components[0:2])
release = falcon.__version__
# -- General configuration ----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode',
'sphinx_copybutton',
'sphinx_design',
'myst_parser',
# Falcon-specific extensions
'ext.autodoc_customizations',
'ext.cibuildwheel',
'ext.doorway',
'ext.private_args',
'ext.rfc',
]
templates_path = ['_templates']
exclude_patterns = ['_build', '_newsfragments']
# The name of the Pygments (syntax highlighting) style to use.
# NOTE(vytas): The PyData theme uses separate Pygments style settings for HTML,
# so we specify a print-friendly theme here for the likes of latexpdf.
pygments_style = 'bw'
# Intersphinx configuration
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
# -- Options for HTML output --------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_css_files = ['custom.css']
html_js_files = ['custom-icons.js']
html_favicon = '_static/img/favicon.ico'
html_logo = '_static/img/logo.svg'
html_static_path = ['_static']
html_theme = 'pydata_sphinx_theme'
html_show_sourcelink = False
html_context = {
# NOTE(vytas): We don't provide any default, the browser's preference
# should be used.
# 'default_mode': 'light',
'prerelease': _prerelease_version, # True if tag is not the empty string
}
# Theme options are theme-specific and customize the look and feel further.
# https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/index.html
html_theme_options = {
'pygments_light_style': 'falconry-light',
'pygments_dark_style': 'falconry-dark',
'header_links_before_dropdown': 4,
'external_links': [
{
'name': 'Get Help',
'url': 'https://falcon.readthedocs.io/community/help.html',
},
{'name': 'Falcon Wiki', 'url': 'https://github.com/falconry/falcon/wiki'},
{
'name': 'Support Falcon',
'url': 'https://falconframework.org/#sectionSupportFalconDevelopment',
},
],
'icon_links': [
{
'name': 'GitHub',
'url': 'https://github.com/falconry/falcon',
'icon': 'fa-brands fa-github',
},
{
'name': 'PyPI',
'url': 'https://pypi.org/project/falcon',
'icon': 'fa-custom fa-pypi',
},
{
'name': 'Falcon Home',
'url': 'https://falconframework.org',
'icon': 'fa-custom fa-falcon',
},
],
# NOTE(vytas): Use only light theme for now.
# Add `theme-switcher` below to resurrect the dark option.
'logo': {
'text': 'Falcon',
# "image_dark": "_static/img/logo.svg",
},
'navbar_end': ['theme-switcher', 'navbar-icon-links'],
'footer_start': ['copyright'],
'footer_end': ['theme-version'],
}
if _dash_build:
html_theme_options.update(font_size=13)
# -- Options for LaTeX output -------------------------------------------------
# NOTE(vytas): The default engine fails to build citing unsupported Unicode
# characters.
latex_engine = 'xelatex'
latex_elements = {
'papersize': 'a4paper',
# The font size ('10pt', '11pt' or '12pt').
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
# 'preamble': '',
}
latex_documents = [
(
'index',
'Falcon.tex',
'Falcon Documentation',
'Kurt Griffiths et al.',
'manual',
),
]
# -- Options for manual page output -------------------------------------------
man_pages = [('index', 'falcon', 'Falcon Documentation', ['Kurt Griffiths et al.'], 1)]
# -- Options for Texinfo output -----------------------------------------------
texinfo_documents = [
(
'index',
'Falcon',
'Falcon Documentation',
'Kurt Griffiths et al.',
'Falcon',
'One line description of project.',
'Miscellaneous',
),
]
|
