forked from scottpetrovic/krita-documentation
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathconf.py
297 lines (203 loc) · 8.97 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Krita Manual'
propername = 'Krita Manual'
description = 'The official Krita Documentation'
copyright = '2018'
author = 'Krita Foundation'
# The short X.Y version
version = '4.0'
# The full version, including alpha/beta/rc tags
release = '4.0.1'
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'en'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A string of reStructuredText that will be included at the end of every source file that is read.
# This is a possible place to add substitutions that should be available in every file (another being rst_prolog).
rst_epilog = """
.. |mouseleft| image:: /images/icons/Krita_mouse_left.png
.. |mouseright| image:: /images/icons/Krita_mouse_right.png
.. |mousemiddle| image:: /images/icons/Krita_mouse_middle.png
.. |mousescroll| image:: /images/icons/Krita_mouse_scroll.png
.. |toolshapeselection| image:: /images/icons/shape_select_tool.svg
.. |toolshapeedit| image:: /images/icons/shape_edit_tool.svg
.. |tooltext| image:: /images/icons/text-tool.svg
.. |toolcalligraphy| image:: /images/icons/calligraphy_tool.svg
.. |toolgradientedit| image:: /images/icons/gradient_edit_tool.svg
.. |toolpatternedit| image:: /images/icons/pattern_tool.svg
.. |toolfreehandbrush| image:: /images/icons/freehand_brush_tool.svg
.. |toolline| image:: /images/icons/line_tool.svg
.. |toolrectangle| image:: /images/icons/rectangle_tool.svg
.. |toolellipse| image:: /images/icons/ellipse_tool.svg
.. |toolpolygon| image:: /images/icons/polygon_tool.svg
.. |toolpolyline| image:: /images/icons/polyline_tool.svg
.. |toolbeziercurve| image:: /images/icons/bezier_curve.svg
.. |toolfreehandpath| image:: /images/icons/freehand_path_tool.svg
.. |tooldyna| image:: /images/icons/dyna_tool.svg
.. |toolmultibrush| image:: /images/icons/multibrush_tool.svg
.. |toolassistant| image:: /images/icons/assistant_tool.svg
.. |toolmove| image:: /images/icons/move_tool.svg
.. |tooltransform| image:: /images/icons/transform_tool.svg
.. |toolgrid| image:: /images/icons/grid_tool.svg
.. |toolperspectivegrid| image:: /images/icons/perspectivegrid_tool.svg
.. |toolmeasure| image:: /images/icons/measure_tool.svg
.. |toolcolorpicker| image:: /images/icons/color_picker_tool.svg
.. |toolfill| image:: /images/icons/fill_tool.svg
.. |toolgradient| image:: /images/icons/gradient_drawing_tool.svg
.. |toolcolorizemask| image:: /images/icons/colorizemask_tool.svg
.. |toolsmartpatch| image:: /images/icons/smart_patch_tool.svg
.. |toolcrop| image:: /images/icons/crop_tool.svg
.. |toolselectrect| image:: /images/icons/rectangular_select_tool.svg
.. |toolselectellipse| image:: /images/icons/elliptical_select_tool.svg
.. |toolselectpolygon| image:: /images/icons/polygonal_select_tool.svg
.. |toolselectpath| image:: /images/icons/path_select_tool.svg
.. |toolselectoutline| image:: /images/icons/outline_select_tool.svg
.. |toolselectcontiguous| image:: /images/icons/contiguous_select_tool.svg
.. |toolselectsimilar| image:: /images/icons/similar_select_tool.svg
.. |toolpan| image:: /images/icons/pan_tool.svg
.. |toolzoom| image:: /images/icons/zoom_tool.svg
"""
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'theme'
html_theme_path = ['.'] # make sphinx search for themes in current dir
# the favicon has a property to set it in the documentation, but we don't need to use this
# sphinx appears to automatically search in the theme folder and find the file
#html_favicon = './theme/static/images/favicon.ico'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'sticky_navigation': True,
'collapse_navigation': True,
'prev_next_buttons_location': 'bottom'
}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['theme/static']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# The default sidebars (for documents that don't match any pattern) are
# defined by theme itself. Builtin themes are using these templates by
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
# 'searchbox.html']``.
#
# html_sidebars = {}
html_title = project + " version " + release
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'documentationProjectNamedoc'
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'kritaManual.tex', project,
author, 'manual'),
]
# -- Internationalization Options --------------------------------------------
locale_dirs = ['locale/'] # Where the PO files will be stored at
gettext_compact = False # optional.
gettext_additional_targets = ['image'] # allows images to be translatable
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, project, propername,
[author], 1)
]
# -- Options for Texinfo output ----------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, project, propername,
author, project, description,
'Manual'),
]
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
#
# epub_identifier = ''
# A unique identification for the text.
#
# epub_uid = ''
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}