]> git.pld-linux.org Git - packages/python-pyasn1.git/blob - python-pyasn1-missing.patch
- added missing patch (doc conf.py file taken from git)
[packages/python-pyasn1.git] / python-pyasn1-missing.patch
1 --- pyasn1-0.2.3/doc/source/conf.py.orig        1970-01-01 01:00:00.000000000 +0100
2 +++ pyasn1-0.2.3/doc/source/conf.py     2017-03-03 20:10:48.711197580 +0100
3 @@ -0,0 +1,323 @@
4 +# -*- coding: utf-8 -*-
5 +#
6 +# PyASN1 documentation build configuration file, created by
7 +# sphinx-quickstart on Sat Jun 27 23:15:54 2015.
8 +#
9 +# This file is execfile()d with the current directory set to its
10 +# containing dir.
11 +#
12 +# Note that not all possible configuration values are present in this
13 +# autogenerated file.
14 +#
15 +# All configuration values have a default; values that are commented out
16 +# serve to show the default.
17 +
18 +import sys
19 +import os
20 +import shlex
21 +
22 +# If extensions (or modules to document with autodoc) are in another directory,
23 +# add these directories to sys.path here. If the directory is relative to the
24 +# documentation root, use os.path.abspath to make it absolute, like shown here.
25 +# sys.path.insert(0, os.path.abspath('.'))
26 +
27 +# -- General configuration ------------------------------------------------
28 +
29 +# If your documentation needs a minimal Sphinx version, state it here.
30 +# needs_sphinx = '1.0'
31 +
32 +# Add any Sphinx extension module names here, as strings. They can be
33 +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
34 +# ones.
35 +extensions = [
36 +    'sphinx.ext.autodoc',
37 +    'sphinx.ext.napoleon',
38 +    'sphinx.ext.doctest',
39 +    'sphinx.ext.intersphinx',
40 +    'sphinx.ext.todo'
41 +]
42 +
43 +# Add any paths that contain templates here, relative to this directory.
44 +templates_path = ['.templates']
45 +
46 +# The suffix(es) of source filenames.
47 +# You can specify multiple suffix as a list of string:
48 +# source_suffix = ['.rst', '.md']
49 +source_suffix = '.rst'
50 +
51 +# The encoding of source files.
52 +# source_encoding = 'utf-8-sig'
53 +
54 +# The master toctree document.
55 +master_doc = 'contents'
56 +
57 +# General information about the project.
58 +project = u'PyASN1'
59 +# noinspection PyShadowingBuiltins
60 +copyright = u'2005-2017, Ilya Etingof <etingof@gmail.com>'
61 +author = u'Ilya Etingof <etingof@gmail.com>'
62 +
63 +# The version info for the project you're documenting, acts as replacement for
64 +# |version| and |release|, also used in various other places throughout the
65 +# built documents.
66 +#
67 +# The short X.Y version.
68 +version = '0.1'
69 +# The full version, including alpha/beta/rc tags.
70 +release = '0.1.10'
71 +
72 +# The language for content autogenerated by Sphinx. Refer to documentation
73 +# for a list of supported languages.
74 +#
75 +# This is also used if you do content translation via gettext catalogs.
76 +# Usually you set "language" from the command line for these cases.
77 +language = None
78 +
79 +# There are two options for replacing |today|: either, you set today to some
80 +# non-false value, then it is used:
81 +# today = ''
82 +# Else, today_fmt is used as the format for a strftime call.
83 +# today_fmt = '%B %d, %Y'
84 +
85 +# List of patterns, relative to source directory, that match files and
86 +# directories to ignore when looking for source files.
87 +exclude_patterns = []
88 +
89 +# The reST default role (used for this markup: `text`) to use for all
90 +# documents.
91 +# default_role = None
92 +
93 +# If true, '()' will be appended to :func: etc. cross-reference text.
94 +# add_function_parentheses = True
95 +
96 +# If true, the current module name will be prepended to all description
97 +# unit titles (such as .. function::).
98 +# add_module_names = True
99 +
100 +# If true, sectionauthor and moduleauthor directives will be shown in the
101 +# output. They are ignored by default.
102 +# show_authors = False
103 +
104 +# The name of the Pygments (syntax highlighting) style to use.
105 +pygments_style = 'sphinx'
106 +
107 +# A list of ignored prefixes for module index sorting.
108 +# modindex_common_prefix = []
109 +
110 +# If true, keep warnings as "system message" paragraphs in the built documents.
111 +# keep_warnings = False
112 +
113 +# If true, `todo` and `todoList` produce output, else they produce nothing.
114 +todo_include_todos = True
115 +
116 +# -- Options for HTML output ----------------------------------------------
117 +
118 +# The theme to use for HTML and HTML Help pages.  See the documentation for
119 +# a list of builtin themes.
120 +# html_theme = 'alabaster'
121 +html_theme = 'sphinx_rtd_theme'
122 +
123 +# Theme options are theme-specific and customize the look and feel of a theme
124 +# further.  For a list of options available for each theme, see the
125 +# documentation.
126 +# html_theme_options = {}
127 +
128 +# Add any paths that contain custom themes here, relative to this directory.
129 +# html_theme_path = []
130 +
131 +# The name for this set of Sphinx documents.  If None, it defaults to
132 +# "<project> v<release> documentation".
133 +# html_title = None
134 +html_title = "PyASN1"
135 +
136 +# A shorter title for the navigation bar.  Default is the same as html_title.
137 +# html_short_title = None
138 +
139 +# The name of an image file (relative to this directory) to place at the top
140 +# of the sidebar.
141 +# html_logo = ""
142 +
143 +# The name of an image file (within the static path) to use as favicon of the
144 +# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
145 +# pixels large.
146 +# html_favicon = None
147 +
148 +# Add any paths that contain custom static files (such as style sheets) here,
149 +# relative to this directory. They are copied after the builtin static files,
150 +# so a file named "default.css" will overwrite the builtin "default.css".
151 +if 'PYASN1DEV' in os.environ:
152 +    html_static_path = ['.static']
153 +
154 +# Custom CSS theme
155 +if 'PYASN1DEV' in os.environ:
156 +    html_style = 'css/rtdimproved.css'
157 +
158 +# Add any extra paths that contain custom files (such as robots.txt or
159 +# .htaccess) here, relative to this directory. These files are copied
160 +# directly to the root of the documentation.
161 +# html_extra_path = []
162 +
163 +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
164 +# using the given strftime format.
165 +# html_last_updated_fmt = '%b %d, %Y'
166 +
167 +# If true, SmartyPants will be used to convert quotes and dashes to
168 +# typographically correct entities.
169 +# html_use_smartypants = True
170 +
171 +# Custom sidebar templates, maps document names to template names.
172 +# html_sidebars = {}
173 +
174 +# Additional templates that should be rendered to pages, maps page names to
175 +# template names.
176 +# html_additional_pages = {}
177 +
178 +# If false, no module index is generated.
179 +# html_domain_indices = True
180 +
181 +# If false, no index is generated.
182 +# html_use_index = True
183 +
184 +# If true, the index is split into individual pages for each letter.
185 +# html_split_index = False
186 +
187 +# If true, links to the reST sources are added to the pages.
188 +html_show_sourcelink = False
189 +
190 +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
191 +html_show_sphinx = False
192 +
193 +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
194 +# html_show_copyright = True
195 +
196 +# If true, an OpenSearch description file will be output, and all pages will
197 +# contain a <link> tag referring to it.  The value of this option must be the
198 +# base URL from which the finished HTML is served.
199 +# html_use_opensearch = ''
200 +
201 +# This is the file name suffix for HTML files (e.g. ".xhtml").
202 +# html_file_suffix = None
203 +
204 +# Language to be used for generating the HTML full-text search index.
205 +# Sphinx supports the following languages:
206 +#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
207 +#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
208 +# html_search_language = 'en'
209 +
210 +# A dictionary with options for the search language support, empty by default.
211 +# Now only 'ja' uses this config value
212 +# html_search_options = {'type': 'default'}
213 +
214 +# The name of a javascript file (relative to the configuration directory) that
215 +# implements a search results scorer. If empty, the default will be used.
216 +# html_search_scorer = 'scorer.js'
217 +
218 +# Output file base name for HTML help builder.
219 +htmlhelp_basename = 'pyasn1doc'
220 +
221 +html_context = {
222 +    'include_analytics': 'PYASN1DEV' in os.environ
223 +}
224 +
225 +# -- Options for LaTeX output ---------------------------------------------
226 +
227 +latex_elements = {
228 +    # The paper size ('letterpaper' or 'a4paper').
229 +    # 'papersize': 'letterpaper',
230 +
231 +    # The font size ('10pt', '11pt' or '12pt').
232 +    # 'pointsize': '10pt',
233 +
234 +    # Additional stuff for the LaTeX preamble.
235 +    # 'preamble': '',
236 +
237 +    # Latex figure (float) alignment
238 +    # 'figure_align': 'htbp',
239 +}
240 +
241 +# Grouping the document tree into LaTeX files. List of tuples
242 +# (source start file, target name, title,
243 +#  author, documentclass [howto, manual, or own class]).
244 +latex_documents = [
245 +    (master_doc, 'PyASN1.tex', u'PyASN1 Documentation',
246 +     u'Ilya Etingof \\textless{}etingof@gmail.com\\textgreater{}', 'manual'),
247 +]
248 +
249 +# The name of an image file (relative to this directory) to place at the top of
250 +# the title page.
251 +# latex_logo = None
252 +
253 +# For "manual" documents, if this is true, then toplevel headings are parts,
254 +# not chapters.
255 +# latex_use_parts = False
256 +
257 +# If true, show page references after internal links.
258 +# latex_show_pagerefs = False
259 +
260 +# If true, show URL addresses after external links.
261 +# latex_show_urls = False
262 +
263 +# Documents to append as an appendix to all manuals.
264 +# latex_appendices = []
265 +
266 +# If false, no module index is generated.
267 +# latex_domain_indices = True
268 +
269 +
270 +# -- Options for manual page output ---------------------------------------
271 +
272 +# One entry per manual page. List of tuples
273 +# (source start file, name, description, authors, manual section).
274 +man_pages = [
275 +    (master_doc, 'pyasn1', u'PyASN1 Documentation',
276 +     [author], 1)
277 +]
278 +
279 +# If true, show URL addresses after external links.
280 +# man_show_urls = False
281 +
282 +
283 +# -- Options for Texinfo output -------------------------------------------
284 +
285 +# Grouping the document tree into Texinfo files. List of tuples
286 +# (source start file, target name, title, author,
287 +#  dir menu entry, description, category)
288 +texinfo_documents = [
289 +    (master_doc, 'PyASN1', u'PyASN1 Documentation',
290 +     author, 'PyASN1', 'One line description of project.',
291 +     'Miscellaneous'),
292 +]
293 +
294 +# Documents to append as an appendix to all manuals.
295 +# texinfo_appendices = []
296 +
297 +# If false, no module index is generated.
298 +# texinfo_domain_indices = True
299 +
300 +# How to display URL addresses: 'footnote', 'no', or 'inline'.
301 +# texinfo_show_urls = 'footnote'
302 +
303 +# If true, do not generate a @detailmenu in the "Top" node's menu.
304 +# texinfo_no_detailmenu = False
305 +
306 +
307 +# Example configuration for intersphinx: refer to the Python standard library.
308 +intersphinx_mapping = {'python': ('https://docs.python.org/3.4/', None)}
309 +
310 +# this merges constructor docstring with class docstring
311 +autoclass_content = 'both'
312 +# Sort members by type
313 +autodoc_member_order = 'bysource'
314 +# autodoc_member_order = 'groupwise'
315 +
316 +# Napoleon settings
317 +napoleon_google_docstring = False
318 +napoleon_numpy_docstring = True
319 +napoleon_include_private_with_doc = False
320 +napoleon_include_special_with_doc = True
321 +napoleon_use_admonition_for_examples = False
322 +napoleon_use_admonition_for_notes = False
323 +napoleon_use_admonition_for_references = False
324 +napoleon_use_ivar = False
325 +napoleon_use_param = False
326 +napoleon_use_rtype = False
This page took 0.074437 seconds and 3 git commands to generate.