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