1
# -*- coding: utf-8 -*-
3
# Widelands documentation build configuration file, created by
4
# sphinx-quickstart on Fri Jun 01 11:27:52 2012.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
13
# For a complete list of options see: http://www.sphinx-doc.org/en/stable/config.html
17
# If extensions (or modules to document with autodoc) are in another directory,
18
# add these directories to sys.path here. If the directory is relative to the
19
# documentation root, use os.path.abspath to make it absolute, like shown here.
20
#sys.path.insert(0, os.path.abspath('.'))
22
# -- General configuration -----------------------------------------------------
24
# If your documentation needs a minimal Sphinx version, state it here.
27
# Add any Sphinx extension module names here, as strings. They can be extensions
28
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29
extensions = ['sphinx.ext.mathjax']
31
# Add any paths that contain templates here, relative to this directory.
32
templates_path = ['_templates']
34
# The suffix of source filenames.
35
source_suffix = '.rst'
37
# The encoding of source files.
38
#source_encoding = 'utf-8-sig'
40
# The master toctree document.
43
# General information about the project.
44
project = u'Widelands'
45
copyright = u'The Widelands Development Team'
47
# The version info for the project you're documenting, acts as replacement for
48
# |version| and |release|, also used in various other places throughout the
51
# The short X.Y version.
53
# The full version, including alpha/beta/rc tags.
56
# The language for content autogenerated by Sphinx. Refer to documentation
57
# for a list of supported languages.
60
# There are two options for replacing |today|: either, you set today to some
61
# non-false value, then it is used:
63
# Else, today_fmt is used as the format for a strftime call.
64
#today_fmt = '%B %d, %Y'
66
# List of patterns, relative to source directory, that match files and
67
# directories to ignore when looking for source files.
70
# The reST default role (used for this markup: `text`) to use for all documents.
73
# If true, '()' will be appended to :func: etc. cross-reference text.
74
#add_function_parentheses = True
76
# If true, the current module name will be prepended to all description
77
# unit titles (such as .. function::).
78
#add_module_names = True
80
# If true, sectionauthor and moduleauthor directives will be shown in the
81
# output. They are ignored by default.
84
# The name of the Pygments (syntax highlighting) style to use.
85
pygments_style = 'sphinx'
87
# A list of ignored prefixes for module index sorting.
88
#modindex_common_prefix = []
90
highlight_language = 'lua'
93
# -- Options for HTML output ---------------------------------------------------
95
# The theme to use for HTML and HTML Help pages. See the documentation for
96
# a list of builtin themes.
99
# Theme options are theme-specific and customize the look and feel of a theme
100
# further. For a list of options available for each theme, see the
102
html_theme_options = {}
104
# Add any paths that contain custom themes here, relative to this directory.
105
#html_theme_path = []
107
# The name for this set of Sphinx documents. If None, it defaults to
108
# "<project> v<release> documentation".
111
# A shorter title for the navigation bar. Default is the same as html_title.
112
#html_short_title = None
114
# The name of an image file (relative to this directory) to place at the top
118
# The name of an image file (within the static path) to use as favicon of the
119
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
123
# Add any paths that contain custom static files (such as style sheets) here,
124
# relative to this directory. They are copied after the builtin static files,
125
# so a file named "default.css" will overwrite the builtin "default.css".
126
html_static_path = ['static/']
128
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
129
# using the given strftime format.
130
html_last_updated_fmt = '%b %d, %Y'
132
# If true, SmartyPants will be used to convert quotes and dashes to
133
# typographically correct entities.
134
#html_use_smartypants = True
136
# Custom sidebar templates, maps document names to template names.
139
# Additional templates that should be rendered to pages, maps page names to
141
#html_additional_pages = {}
143
# If false, no module index is generated.
144
html_domain_indices = False
146
# If false, no index is generated.
147
html_use_index = True
149
# If true, the index is split into individual pages for each letter.
150
#html_split_index = False
152
# If true, links to the reST sources are added to the pages.
153
#html_show_sourcelink = True
155
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156
#html_show_sphinx = True
158
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159
#html_show_copyright = True
161
# If true, an OpenSearch description file will be output, and all pages will
162
# contain a <link> tag referring to it. The value of this option must be the
163
# base URL from which the finished HTML is served.
164
#html_use_opensearch = ''
166
# This is the file name suffix for HTML files (e.g. ".xhtml").
167
#html_file_suffix = None
170
# Output file base name for HTML help builder.
171
htmlhelp_basename = 'Widelandsdoc'
added
removed
documentation/conf.py
