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