@@ -32,8 +32,9 @@ def read_file(*parts):
32
32
33
33
def find_version (* file_paths ):
34
34
version_file = read_file (* file_paths )
35
- version_match = re .search (r"^__version__ = ['\"]([^'\"]*)['\"]" ,
36
- version_file , re .M )
35
+ version_match = re .search (
36
+ r"^__version__ = ['\"]([^'\"]*)['\"]" , version_file , re .M
37
+ )
37
38
if version_match :
38
39
return version_match .group (1 )
39
40
raise RuntimeError ("Unable to find version string." )
@@ -45,34 +46,34 @@ def find_version(*file_paths):
45
46
# If extensions (or modules to document with autodoc) are in another directory,
46
47
# add these directories to sys.path here. If the directory is relative to the
47
48
# documentation root, use os.path.abspath to make it absolute, like shown here.
48
- #sys.path.insert(0, os.path.abspath('.'))
49
+ # sys.path.insert(0, os.path.abspath('.'))
49
50
50
51
# -- General configuration -----------------------------------------------------
51
52
52
53
# If your documentation needs a minimal Sphinx version, state it here.
53
- needs_sphinx = ' 1.0'
54
+ needs_sphinx = " 1.0"
54
55
55
56
# Add any Sphinx extension module names here, as strings. They can be
56
57
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
57
58
extensions = [
58
59
"sphinx.ext.autodoc" ,
59
- ' sphinx.ext.intersphinx' ,
60
+ " sphinx.ext.intersphinx" ,
60
61
]
61
62
62
63
# Add any paths that contain templates here, relative to this directory.
63
- templates_path = [' _templates' ]
64
+ templates_path = [" _templates" ]
64
65
65
66
# The suffix of source filenames.
66
- source_suffix = ' .rst'
67
+ source_suffix = " .rst"
67
68
68
69
# The encoding of source files.
69
- #source_encoding = 'utf-8-sig'
70
+ # source_encoding = 'utf-8-sig'
70
71
71
72
# The master toctree document.
72
- master_doc = ' index'
73
+ master_doc = " index"
73
74
74
75
# General information about the project.
75
- project = u' pyOpenSSL'
76
+ project = u" pyOpenSSL"
76
77
authors = u"The pyOpenSSL developers"
77
78
copyright = u"2001 " + authors
78
79
@@ -87,73 +88,74 @@ def find_version(*file_paths):
87
88
88
89
# The language for content autogenerated by Sphinx. Refer to documentation
89
90
# for a list of supported languages.
90
- #language = None
91
+ # language = None
91
92
92
93
# There are two options for replacing |today|: either, you set today to some
93
94
# non-false value, then it is used:
94
- #today = ''
95
+ # today = ''
95
96
# Else, today_fmt is used as the format for a strftime call.
96
- #today_fmt = '%B %d, %Y'
97
+ # today_fmt = '%B %d, %Y'
97
98
98
99
# List of patterns, relative to source directory, that match files and
99
100
# directories to ignore when looking for source files.
100
- exclude_patterns = [' _build' ]
101
+ exclude_patterns = [" _build" ]
101
102
102
103
# The reST default role (used for this markup: `text`) to use for all documents.
103
- #default_role = None
104
+ # default_role = None
104
105
105
106
# If true, '()' will be appended to :func: etc. cross-reference text.
106
- #add_function_parentheses = True
107
+ # add_function_parentheses = True
107
108
108
109
# If true, the current module name will be prepended to all description
109
110
# unit titles (such as .. function::).
110
- #add_module_names = True
111
+ # add_module_names = True
111
112
112
113
# If true, sectionauthor and moduleauthor directives will be shown in the
113
114
# output. They are ignored by default.
114
- #show_authors = False
115
+ # show_authors = False
115
116
116
117
# The name of the Pygments (syntax highlighting) style to use.
117
- pygments_style = ' sphinx'
118
+ pygments_style = " sphinx"
118
119
119
120
# A list of ignored prefixes for module index sorting.
120
- #modindex_common_prefix = []
121
+ # modindex_common_prefix = []
121
122
122
123
123
124
# -- Options for HTML output ---------------------------------------------------
124
125
125
126
# The theme to use for HTML and HTML Help pages. See the documentation for
126
127
# a list of builtin themes.
127
- on_rtd = os .environ .get (' READTHEDOCS' , None ) == ' True'
128
+ on_rtd = os .environ .get (" READTHEDOCS" , None ) == " True"
128
129
129
130
if not on_rtd : # only import and set the theme if we're building docs locally
130
131
import sphinx_rtd_theme
131
- html_theme = 'sphinx_rtd_theme'
132
+
133
+ html_theme = "sphinx_rtd_theme"
132
134
html_theme_path = [sphinx_rtd_theme .get_html_theme_path ()]
133
135
134
136
# Theme options are theme-specific and customize the look and feel of a theme
135
137
# further. For a list of options available for each theme, see the
136
138
# documentation.
137
- #html_theme_options = {}
139
+ # html_theme_options = {}
138
140
139
141
# Add any paths that contain custom themes here, relative to this directory.
140
- #html_theme_path = []
142
+ # html_theme_path = []
141
143
142
144
# The name for this set of Sphinx documents. If None, it defaults to
143
145
# "<project> v<release> documentation".
144
- #html_title = None
146
+ # html_title = None
145
147
146
148
# A shorter title for the navigation bar. Default is the same as html_title.
147
- #html_short_title = None
149
+ # html_short_title = None
148
150
149
151
# The name of an image file (relative to this directory) to place at the top
150
152
# of the sidebar.
151
- #html_logo = None
153
+ # html_logo = None
152
154
153
155
# The name of an image file (within the static path) to use as favicon of the
154
156
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
155
157
# pixels large.
156
- #html_favicon = None
158
+ # html_favicon = None
157
159
158
160
# Add any paths that contain custom static files (such as style sheets) here,
159
161
# relative to this directory. They are copied after the builtin static files,
@@ -162,96 +164,92 @@ def find_version(*file_paths):
162
164
163
165
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164
166
# using the given strftime format.
165
- #html_last_updated_fmt = '%b %d, %Y'
167
+ # html_last_updated_fmt = '%b %d, %Y'
166
168
167
169
# If true, SmartyPants will be used to convert quotes and dashes to
168
170
# typographically correct entities.
169
- #html_use_smartypants = True
171
+ # html_use_smartypants = True
170
172
171
173
# Custom sidebar templates, maps document names to template names.
172
- #html_sidebars = {}
174
+ # html_sidebars = {}
173
175
174
176
# Additional templates that should be rendered to pages, maps page names to
175
177
# template names.
176
- #html_additional_pages = {}
178
+ # html_additional_pages = {}
177
179
178
180
# If false, no module index is generated.
179
- #html_domain_indices = True
181
+ # html_domain_indices = True
180
182
181
183
# If false, no index is generated.
182
- #html_use_index = True
184
+ # html_use_index = True
183
185
184
186
# If true, the index is split into individual pages for each letter.
185
- #html_split_index = False
187
+ # html_split_index = False
186
188
187
189
# If true, links to the reST sources are added to the pages.
188
- #html_show_sourcelink = True
190
+ # html_show_sourcelink = True
189
191
190
192
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
191
- #html_show_sphinx = True
193
+ # html_show_sphinx = True
192
194
193
195
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
194
- #html_show_copyright = True
196
+ # html_show_copyright = True
195
197
196
198
# If true, an OpenSearch description file will be output, and all pages will
197
199
# contain a <link> tag referring to it. The value of this option must be the
198
200
# base URL from which the finished HTML is served.
199
- #html_use_opensearch = ''
201
+ # html_use_opensearch = ''
200
202
201
203
# This is the file name suffix for HTML files (e.g. ".xhtml").
202
- #html_file_suffix = None
204
+ # html_file_suffix = None
203
205
204
206
# Output file base name for HTML help builder.
205
- htmlhelp_basename = ' pyOpenSSLdoc'
207
+ htmlhelp_basename = " pyOpenSSLdoc"
206
208
207
209
208
210
# -- Options for LaTeX output --------------------------------------------------
209
211
210
212
# The paper size ('letter' or 'a4').
211
- #latex_paper_size = 'letter'
213
+ # latex_paper_size = 'letter'
212
214
213
215
# The font size ('10pt', '11pt' or '12pt').
214
- #latex_font_size = '10pt'
216
+ # latex_font_size = '10pt'
215
217
216
218
# Grouping the document tree into LaTeX files. List of tuples
217
219
# (source start file, target name, title, author, documentclass [howto/manual]).
218
220
latex_documents = [
219
- ('index' , 'pyOpenSSL.tex' , u'pyOpenSSL Documentation' ,
220
- authors , 'manual' ),
221
+ ("index" , "pyOpenSSL.tex" , u"pyOpenSSL Documentation" , authors , "manual" ),
221
222
]
222
223
223
224
# The name of an image file (relative to this directory) to place at the top of
224
225
# the title page.
225
- #latex_logo = None
226
+ # latex_logo = None
226
227
227
228
# For "manual" documents, if this is true, then toplevel headings are parts,
228
229
# not chapters.
229
- #latex_use_parts = False
230
+ # latex_use_parts = False
230
231
231
232
# If true, show page references after internal links.
232
- #latex_show_pagerefs = False
233
+ # latex_show_pagerefs = False
233
234
234
235
# If true, show URL addresses after external links.
235
- #latex_show_urls = False
236
+ # latex_show_urls = False
236
237
237
238
# Additional stuff for the LaTeX preamble.
238
- #latex_preamble = ''
239
+ # latex_preamble = ''
239
240
240
241
# Documents to append as an appendix to all manuals.
241
- #latex_appendices = []
242
+ # latex_appendices = []
242
243
243
244
# If false, no module index is generated.
244
- #latex_domain_indices = True
245
+ # latex_domain_indices = True
245
246
246
247
247
248
# -- Options for manual page output --------------------------------------------
248
249
249
250
# One entry per manual page. List of tuples
250
251
# (source start file, name, description, authors, manual section).
251
- man_pages = [
252
- ('index' , 'pyopenssl' , u'pyOpenSSL Documentation' ,
253
- [authors ], 1 )
254
- ]
252
+ man_pages = [("index" , "pyopenssl" , u"pyOpenSSL Documentation" , [authors ], 1 )]
255
253
256
254
intersphinx_mapping = {
257
255
"https://docs.python.org/3" : None ,
0 commit comments