|
1 | | -# -*- coding: utf-8 -*- |
| 1 | +# Configuration file for the Sphinx documentation builder. |
2 | 2 | # |
3 | | -# complexity documentation build configuration file, created by |
4 | | -# sphinx-quickstart on Tue Jul 9 22:26:36 2013. |
5 | | -# |
6 | | -# This file is execfile()d with the current directory set to its |
7 | | -# containing dir. |
8 | | -# |
9 | | -# Note that not all possible configuration values are present in this |
10 | | -# autogenerated file. |
| 3 | +# This file only contains a selection of the most common options. For a full |
| 4 | +# list see the documentation: |
| 5 | +# https://www.sphinx-doc.org/en/master/usage/configuration.html |
| 6 | + |
| 7 | +# -- Path setup -------------------------------------------------------------- |
| 8 | + |
| 9 | +# If extensions (or modules to document with autodoc) are in another directory, |
| 10 | +# add these directories to sys.path here. If the directory is relative to the |
| 11 | +# documentation root, use os.path.abspath to make it absolute, like shown here. |
11 | 12 | # |
12 | | -# All configuration values have a default; values that are commented out |
13 | | -# serve to show the default. |
| 13 | +# import os |
| 14 | +# import sys |
| 15 | +# sys.path.insert(0, os.path.abspath('.')) |
14 | 16 |
|
15 | | -import sys |
16 | | -import os |
17 | 17 |
|
18 | | -# If extensions (or modules to document with autodoc) are in another |
19 | | -# directory, add these directories to sys.path here. If the directory is |
20 | | -# relative to the documentation root, use os.path.abspath to make it |
21 | | -# absolute, like shown here. |
22 | | -#sys.path.insert(0, os.path.abspath('.')) |
| 18 | +# -- Project information ----------------------------------------------------- |
23 | 19 |
|
24 | | -# Get the project root dir, which is the parent dir of this |
25 | | -cwd = os.getcwd() |
26 | | -project_root = os.path.dirname(cwd) |
| 20 | +project = 'tidalapi' |
| 21 | +copyright = '2014-2019, Thomas Amland, morguldir' |
| 22 | +author = 'Thomas Amland, morguldir' |
27 | 23 |
|
28 | | -# Insert the project root dir as the first element in the PYTHONPATH. |
29 | | -# This lets us ensure that the source package is imported, and that its |
30 | | -# version is used. |
31 | | -sys.path.insert(0, project_root) |
| 24 | +# The full version, including alpha/beta/rc tags |
| 25 | +release = '0.6.1' |
32 | 26 |
|
33 | | -# -- General configuration --------------------------------------------- |
34 | 27 |
|
35 | | -# If your documentation needs a minimal Sphinx version, state it here. |
36 | | -#needs_sphinx = '1.0' |
| 28 | +# -- General configuration --------------------------------------------------- |
37 | 29 |
|
38 | 30 | # Add any Sphinx extension module names here, as strings. They can be |
39 | 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
|
42 | 34 | # Add any paths that contain templates here, relative to this directory. |
43 | 35 | templates_path = ['_templates'] |
44 | 36 |
|
45 | | -# The suffix of source filenames. |
46 | | -source_suffix = '.rst' |
47 | | - |
48 | | -# The encoding of source files. |
49 | | -#source_encoding = 'utf-8-sig' |
50 | | - |
51 | | -# The master toctree document. |
52 | | -master_doc = 'index' |
53 | | - |
54 | | -# General information about the project. |
55 | | -project = u'tidalapi' |
56 | | -copyright = u'2014-2019, Thomas Amland, morguldir' |
57 | | - |
58 | | -# The version info for the project you're documenting, acts as replacement |
59 | | -# for |version| and |release|, also used in various other places throughout |
60 | | -# the built documents. |
61 | | -# |
62 | | -# The short X.Y version. |
63 | | -version = '0.6.1' |
64 | | -# The full version, including alpha/beta/rc tags. |
65 | | -release = version |
66 | | - |
67 | | -# The language for content autogenerated by Sphinx. Refer to documentation |
68 | | -# for a list of supported languages. |
69 | | -#language = None |
70 | | - |
71 | | -# There are two options for replacing |today|: either, you set today to |
72 | | -# some non-false value, then it is used: |
73 | | -#today = '' |
74 | | -# Else, today_fmt is used as the format for a strftime call. |
75 | | -#today_fmt = '%B %d, %Y' |
76 | | - |
77 | 37 | # List of patterns, relative to source directory, that match files and |
78 | 38 | # directories to ignore when looking for source files. |
79 | | -exclude_patterns = ['_build'] |
80 | | - |
81 | | -# The reST default role (used for this markup: `text`) to use for all |
82 | | -# documents. |
83 | | -#default_role = None |
84 | | - |
85 | | -# If true, '()' will be appended to :func: etc. cross-reference text. |
86 | | -#add_function_parentheses = True |
87 | | - |
88 | | -# If true, the current module name will be prepended to all description |
89 | | -# unit titles (such as .. function::). |
90 | | -#add_module_names = True |
91 | | - |
92 | | -# If true, sectionauthor and moduleauthor directives will be shown in the |
93 | | -# output. They are ignored by default. |
94 | | -#show_authors = False |
| 39 | +# This pattern also affects html_static_path and html_extra_path. |
| 40 | +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] |
95 | 41 |
|
96 | | -# The name of the Pygments (syntax highlighting) style to use. |
97 | | -pygments_style = 'sphinx' |
98 | 42 |
|
99 | | -# A list of ignored prefixes for module index sorting. |
100 | | -#modindex_common_prefix = [] |
101 | | - |
102 | | -# If true, keep warnings as "system message" paragraphs in the built |
103 | | -# documents. |
104 | | -#keep_warnings = False |
105 | | - |
106 | | - |
107 | | -# -- Options for HTML output ------------------------------------------- |
| 43 | +# -- Options for HTML output ------------------------------------------------- |
108 | 44 |
|
109 | 45 | # The theme to use for HTML and HTML Help pages. See the documentation for |
110 | 46 | # a list of builtin themes. |
111 | 47 | html_theme = 'pyramid' |
112 | 48 |
|
113 | | -# Theme options are theme-specific and customize the look and feel of a |
114 | | -# theme further. For a list of options available for each theme, see the |
115 | | -# documentation. |
116 | | -#html_theme_options = {} |
117 | | - |
118 | | -# Add any paths that contain custom themes here, relative to this directory. |
119 | | -#html_theme_path = [] |
120 | | - |
121 | | -# The name for this set of Sphinx documents. If None, it defaults to |
122 | | -# "<project> v<release> documentation". |
123 | | -#html_title = None |
124 | | - |
125 | | -# A shorter title for the navigation bar. Default is the same as |
126 | | -# html_title. |
127 | | -#html_short_title = None |
128 | | - |
129 | | -# The name of an image file (relative to this directory) to place at the |
130 | | -# top of the sidebar. |
131 | | -#html_logo = None |
132 | | - |
133 | | -# The name of an image file (within the static path) to use as favicon |
134 | | -# of the docs. This file should be a Windows icon file (.ico) being |
135 | | -# 16x16 or 32x32 pixels large. |
136 | | -#html_favicon = None |
137 | | - |
138 | | -# Add any paths that contain custom static files (such as style sheets) |
139 | | -# here, relative to this directory. They are copied after the builtin |
140 | | -# static files, so a file named "default.css" will overwrite the builtin |
141 | | -# "default.css". |
| 49 | +# Add any paths that contain custom static files (such as style sheets) here, |
| 50 | +# relative to this directory. They are copied after the builtin static files, |
| 51 | +# so a file named "default.css" will overwrite the builtin "default.css". |
142 | 52 | html_static_path = ['_static'] |
143 | | - |
144 | | -# If not '', a 'Last updated on:' timestamp is inserted at every page |
145 | | -# bottom, using the given strftime format. |
146 | | -#html_last_updated_fmt = '%b %d, %Y' |
147 | | - |
148 | | -# If true, SmartyPants will be used to convert quotes and dashes to |
149 | | -# typographically correct entities. |
150 | | -#html_use_smartypants = True |
151 | | - |
152 | | -# Custom sidebar templates, maps document names to template names. |
153 | | -#html_sidebars = {} |
154 | | - |
155 | | -# Additional templates that should be rendered to pages, maps page names |
156 | | -# to template names. |
157 | | -#html_additional_pages = {} |
158 | | - |
159 | | -# If false, no module index is generated. |
160 | | -#html_domain_indices = True |
161 | | - |
162 | | -# If false, no index is generated. |
163 | | -#html_use_index = True |
164 | | - |
165 | | -# If true, the index is split into individual pages for each letter. |
166 | | -#html_split_index = False |
167 | | - |
168 | | -# If true, links to the reST sources are added to the pages. |
169 | | -#html_show_sourcelink = True |
170 | | - |
171 | | -# If true, "Created using Sphinx" is shown in the HTML footer. |
172 | | -# Default is True. |
173 | | -#html_show_sphinx = True |
174 | | - |
175 | | -# If true, "(C) Copyright ..." is shown in the HTML footer. |
176 | | -# Default is True. |
177 | | -#html_show_copyright = True |
178 | | - |
179 | | -# If true, an OpenSearch description file will be output, and all pages |
180 | | -# will contain a <link> tag referring to it. The value of this option |
181 | | -# must be the base URL from which the finished HTML is served. |
182 | | -#html_use_opensearch = '' |
183 | | - |
184 | | -# This is the file name suffix for HTML files (e.g. ".xhtml"). |
185 | | -#html_file_suffix = None |
186 | | - |
187 | | -# Output file base name for HTML help builder. |
188 | | -htmlhelp_basename = 'tidalapidoc' |
189 | | - |
190 | | - |
191 | | -# -- Options for LaTeX output ------------------------------------------ |
192 | | - |
193 | | -latex_elements = { |
194 | | - # The paper size ('letterpaper' or 'a4paper'). |
195 | | - #'papersize': 'letterpaper', |
196 | | - |
197 | | - # The font size ('10pt', '11pt' or '12pt'). |
198 | | - #'pointsize': '10pt', |
199 | | - |
200 | | - # Additional stuff for the LaTeX preamble. |
201 | | - #'preamble': '', |
202 | | -} |
203 | | - |
204 | | -# Grouping the document tree into LaTeX files. List of tuples |
205 | | -# (source start file, target name, title, author, documentclass |
206 | | -# [howto/manual]). |
207 | | -#latex_documents = [] |
208 | | - |
209 | | -# The name of an image file (relative to this directory) to place at |
210 | | -# the top of the title page. |
211 | | -#latex_logo = None |
212 | | - |
213 | | -# For "manual" documents, if this is true, then toplevel headings |
214 | | -# are parts, not chapters. |
215 | | -#latex_use_parts = False |
216 | | - |
217 | | -# If true, show page references after internal links. |
218 | | -#latex_show_pagerefs = False |
219 | | - |
220 | | -# If true, show URL addresses after external links. |
221 | | -#latex_show_urls = False |
222 | | - |
223 | | -# Documents to append as an appendix to all manuals. |
224 | | -#latex_appendices = [] |
225 | | - |
226 | | -# If false, no module index is generated. |
227 | | -#latex_domain_indices = True |
228 | | - |
229 | | - |
230 | | -# -- Options for manual page output ------------------------------------ |
231 | | - |
232 | | -# One entry per manual page. List of tuples |
233 | | -# (source start file, name, description, authors, manual section). |
234 | | -#man_pages = [] |
235 | | - |
236 | | -# If true, show URL addresses after external links. |
237 | | -#man_show_urls = False |
238 | | - |
239 | | - |
240 | | -# -- Options for Texinfo output ---------------------------------------- |
241 | | - |
242 | | -# Grouping the document tree into Texinfo files. List of tuples |
243 | | -# (source start file, target name, title, author, |
244 | | -# dir menu entry, description, category) |
245 | | -#texinfo_documents = [] |
246 | | - |
247 | | -# Documents to append as an appendix to all manuals. |
248 | | -#texinfo_appendices = [] |
249 | | - |
250 | | -# If false, no module index is generated. |
251 | | -#texinfo_domain_indices = True |
252 | | - |
253 | | -# How to display URL addresses: 'footnote', 'no', or 'inline'. |
254 | | -#texinfo_show_urls = 'footnote' |
255 | | - |
256 | | -# If true, do not generate a @detailmenu in the "Top" node's menu. |
257 | | -#texinfo_no_detailmenu = False |
0 commit comments