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