|
11 | 11 | # All configuration values have a default; values that are commented out |
12 | 12 | # serve to show the default. |
13 | 13 |
|
14 | | -import sys, os |
| 14 | +# import sys |
| 15 | +# import os |
15 | 16 | import rsa |
16 | 17 |
|
17 | 18 | # If extensions (or modules to document with autodoc) are in another directory, |
18 | 19 | # add these directories to sys.path here. If the directory is relative to the |
19 | 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
20 | | -#sys.path.insert(0, os.path.abspath('.')) |
| 21 | +# sys.path.insert(0, os.path.abspath('.')) |
21 | 22 |
|
22 | 23 | # -- General configuration ----------------------------------------------------- |
23 | 24 |
|
24 | 25 | # If your documentation needs a minimal Sphinx version, state it here. |
25 | | -#needs_sphinx = '1.0' |
| 26 | +# needs_sphinx = '1.0' |
26 | 27 |
|
27 | 28 | # Add any Sphinx extension module names here, as strings. They can be extensions |
28 | 29 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
29 | 30 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', |
30 | | - 'sphinx.ext.coverage', 'sphinx.ext.pngmath'] |
| 31 | + 'sphinx.ext.coverage', 'sphinx.ext.pngmath'] |
31 | 32 |
|
32 | 33 | # I would like to add 'sphinx.ext.viewcode', but it causes a UnicodeDecodeError |
33 | 34 |
|
|
62 | 63 |
|
63 | 64 | # There are two options for replacing |today|: either, you set today to some |
64 | 65 | # non-false value, then it is used: |
65 | | -#today = '' |
| 66 | +# today = '' |
66 | 67 | # Else, today_fmt is used as the format for a strftime call. |
67 | | -#today_fmt = '%B %d, %Y' |
| 68 | +# today_fmt = '%B %d, %Y' |
68 | 69 |
|
69 | 70 | # List of patterns, relative to source directory, that match files and |
70 | 71 | # directories to ignore when looking for source files. |
71 | 72 | exclude_patterns = ['_build'] |
72 | 73 |
|
73 | 74 | # The reST default role (used for this markup: `text`) to use for all documents. |
74 | | -#default_role = None |
| 75 | +# default_role = None |
75 | 76 |
|
76 | 77 | # If true, '()' will be appended to :func: etc. cross-reference text. |
77 | | -#add_function_parentheses = True |
| 78 | +# add_function_parentheses = True |
78 | 79 |
|
79 | 80 | # If true, the current module name will be prepended to all description |
80 | 81 | # unit titles (such as .. function::). |
81 | | -#add_module_names = True |
| 82 | +# add_module_names = True |
82 | 83 |
|
83 | 84 | # If true, sectionauthor and moduleauthor directives will be shown in the |
84 | 85 | # output. They are ignored by default. |
85 | | -#show_authors = False |
| 86 | +# show_authors = False |
86 | 87 |
|
87 | 88 | # The name of the Pygments (syntax highlighting) style to use. |
88 | 89 | pygments_style = 'sphinx' |
89 | 90 |
|
90 | 91 | # A list of ignored prefixes for module index sorting. |
91 | | -#modindex_common_prefix = [] |
| 92 | +# modindex_common_prefix = [] |
92 | 93 |
|
93 | 94 |
|
94 | 95 | # -- Options for HTML output --------------------------------------------------- |
|
100 | 101 | # Theme options are theme-specific and customize the look and feel of a theme |
101 | 102 | # further. For a list of options available for each theme, see the |
102 | 103 | # documentation. |
103 | | -#html_theme_options = {} |
| 104 | +# html_theme_options = {} |
104 | 105 |
|
105 | 106 | # Add any paths that contain custom themes here, relative to this directory. |
106 | | -#html_theme_path = [] |
| 107 | +# html_theme_path = [] |
107 | 108 |
|
108 | 109 | # The name for this set of Sphinx documents. If None, it defaults to |
109 | 110 | # "<project> v<release> documentation". |
110 | | -#html_title = None |
| 111 | +# html_title = None |
111 | 112 |
|
112 | 113 | # A shorter title for the navigation bar. Default is the same as html_title. |
113 | | -#html_short_title = None |
| 114 | +# html_short_title = None |
114 | 115 |
|
115 | 116 | # The name of an image file (relative to this directory) to place at the top |
116 | 117 | # of the sidebar. |
117 | | -#html_logo = None |
| 118 | +# html_logo = None |
118 | 119 |
|
119 | 120 | # The name of an image file (within the static path) to use as favicon of the |
120 | 121 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 |
121 | 122 | # pixels large. |
122 | | -#html_favicon = None |
| 123 | +# html_favicon = None |
123 | 124 |
|
124 | 125 | # Add any paths that contain custom static files (such as style sheets) here, |
125 | 126 | # relative to this directory. They are copied after the builtin static files, |
|
128 | 129 |
|
129 | 130 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
130 | 131 | # using the given strftime format. |
131 | | -#html_last_updated_fmt = '%b %d, %Y' |
| 132 | +# html_last_updated_fmt = '%b %d, %Y' |
132 | 133 |
|
133 | 134 | # If true, SmartyPants will be used to convert quotes and dashes to |
134 | 135 | # typographically correct entities. |
135 | | -#html_use_smartypants = True |
| 136 | +# html_use_smartypants = True |
136 | 137 |
|
137 | 138 | # Custom sidebar templates, maps document names to template names. |
138 | | -#html_sidebars = {} |
| 139 | +# html_sidebars = {} |
139 | 140 |
|
140 | 141 | # Additional templates that should be rendered to pages, maps page names to |
141 | 142 | # template names. |
142 | | -#html_additional_pages = {} |
| 143 | +# html_additional_pages = {} |
143 | 144 |
|
144 | 145 | # If false, no module index is generated. |
145 | | -#html_domain_indices = True |
| 146 | +# html_domain_indices = True |
146 | 147 |
|
147 | 148 | # If false, no index is generated. |
148 | | -#html_use_index = True |
| 149 | +# html_use_index = True |
149 | 150 |
|
150 | 151 | # If true, the index is split into individual pages for each letter. |
151 | | -#html_split_index = False |
| 152 | +# html_split_index = False |
152 | 153 |
|
153 | 154 | # If true, links to the reST sources are added to the pages. |
154 | | -#html_show_sourcelink = True |
| 155 | +# html_show_sourcelink = True |
155 | 156 |
|
156 | 157 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
157 | | -#html_show_sphinx = True |
| 158 | +# html_show_sphinx = True |
158 | 159 |
|
159 | 160 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
160 | | -#html_show_copyright = True |
| 161 | +# html_show_copyright = True |
161 | 162 |
|
162 | 163 | # If true, an OpenSearch description file will be output, and all pages will |
163 | 164 | # contain a <link> tag referring to it. The value of this option must be the |
164 | 165 | # base URL from which the finished HTML is served. |
165 | | -#html_use_opensearch = '' |
| 166 | +# html_use_opensearch = '' |
166 | 167 |
|
167 | 168 | # This is the file name suffix for HTML files (e.g. ".xhtml"). |
168 | | -#html_file_suffix = None |
| 169 | +# html_file_suffix = None |
169 | 170 |
|
170 | 171 | # Output file base name for HTML help builder. |
171 | 172 | htmlhelp_basename = 'Python-RSAdoc' |
172 | 173 |
|
173 | | - |
174 | 174 | # -- Options for LaTeX output -------------------------------------------------- |
175 | 175 |
|
176 | 176 | # The paper size ('letter' or 'a4'). |
177 | | -#latex_paper_size = 'letter' |
| 177 | +# latex_paper_size = 'letter' |
178 | 178 |
|
179 | 179 | # The font size ('10pt', '11pt' or '12pt'). |
180 | | -#latex_font_size = '10pt' |
| 180 | +# latex_font_size = '10pt' |
181 | 181 |
|
182 | 182 | # Grouping the document tree into LaTeX files. List of tuples |
183 | 183 | # (source start file, target name, title, author, documentclass [howto/manual]). |
184 | 184 | latex_documents = [ |
185 | | - ('index', 'Python-RSA.tex', u'Python-RSA Documentation', |
186 | | - u'Sybren A. Stüvel', 'manual'), |
| 185 | + ('index', 'Python-RSA.tex', u'Python-RSA Documentation', |
| 186 | + u'Sybren A. Stüvel', 'manual'), |
187 | 187 | ] |
188 | 188 |
|
189 | 189 | # The name of an image file (relative to this directory) to place at the top of |
190 | 190 | # the title page. |
191 | | -#latex_logo = None |
| 191 | +# latex_logo = None |
192 | 192 |
|
193 | 193 | # For "manual" documents, if this is true, then toplevel headings are parts, |
194 | 194 | # not chapters. |
195 | | -#latex_use_parts = False |
| 195 | +# latex_use_parts = False |
196 | 196 |
|
197 | 197 | # If true, show page references after internal links. |
198 | | -#latex_show_pagerefs = False |
| 198 | +# latex_show_pagerefs = False |
199 | 199 |
|
200 | 200 | # If true, show URL addresses after external links. |
201 | | -#latex_show_urls = False |
| 201 | +# latex_show_urls = False |
202 | 202 |
|
203 | 203 | # Additional stuff for the LaTeX preamble. |
204 | | -#latex_preamble = '' |
| 204 | +# latex_preamble = '' |
205 | 205 |
|
206 | 206 | # Documents to append as an appendix to all manuals. |
207 | | -#latex_appendices = [] |
| 207 | +# latex_appendices = [] |
208 | 208 |
|
209 | 209 | # If false, no module index is generated. |
210 | | -#latex_domain_indices = True |
| 210 | +# latex_domain_indices = True |
211 | 211 |
|
212 | 212 |
|
213 | 213 | # -- Options for manual page output -------------------------------------------- |
|
220 | 220 | ] |
221 | 221 |
|
222 | 222 | todo_include_todos = True |
223 | | - |
0 commit comments