Debian Codegraph @

storage/maria/libmarias3/docs/conf.py

raw
1 # -*- coding: utf-8 -*-
2 #
3 # DDm4 documentation build configuration file, created by
4 # sphinx-quickstart on Sun Mar 6 12:05:53 2011.
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.
13
14 import sys, os
15 from subprocess import Popen, PIPE
16
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('.'))
21
22 # -- General configuration -----------------------------------------------------
23
24 # If your documentation needs a minimal Sphinx version, state it here.
25 needs_sphinx = '1.1'
26
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 = []
30
31 #extensions = ['sphinxcontrib.googleanalytics']
32
33 # Google
34 #googleanalytics_id = ''
35 #googleanalytics_enabled = 'False'
36
37 # Add any paths that contain templates here, relative to this directory.
38 #templates_path = ['_templates']
39
40 # The suffix of source filenames.
41 source_suffix = '.rst'
42
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
45
46 # The master toctree document.
47 master_doc = 'index'
48
49 # General information about the project.
50 project = u'libmarias3'
51 copyright = u'2019 MariaDB Corporation Ab'
52
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
55 # built documents.
56 #
57 # The short X.Y version.
58 version_file = open("../VERSION.txt", "r")
59 version = version_file.read().strip()
60 # The full version, including alpha/beta/rc tags.
61 get_rev= Popen("git rev-parse --short HEAD", shell=True, stdout=PIPE).stdout.read().strip()
62 release = version + '-' + get_rev.decode("utf-8")
63
64 # The language for content autogenerated by Sphinx. Refer to documentation
65 # for a list of supported languages.
66 # language = en
67
68 primary_domain='c'
69
70 # There are two options for replacing |today|: either, you set today to some
71 # non-false value, then it is used:
72 #today = ''
73 # Else, today_fmt is used as the format for a strftime call.
74 #today_fmt = '%B %d, %Y'
75
76 # List of patterns, relative to source directory, that match files and
77 # directories to ignore when looking for source files.
78 exclude_patterns = ['_build']
79
80 # The reST default role (used for this markup: `text`) to use for all documents.
81 #default_role = None
82
83 # If true, '()' will be appended to :func: etc. cross-reference text.
84 #add_function_parentheses = True
85
86 # If true, the current module name will be prepended to all description
87 # unit titles (such as .. function::).
88 #add_module_names = True
89
90 # If true, sectionauthor and moduleauthor directives will be shown in the
91 # output. They are ignored by default.
92 #show_authors = False
93
94 # The name of the Pygments (syntax highlighting) style to use.
95 pygments_style = 'colorful'
96
97 # A list of ignored prefixes for module index sorting.
98 #modindex_common_prefix = []
99
100
101 # -- Options for HTML output ---------------------------------------------------
102
103 # The theme to use for HTML and HTML Help pages. See the documentation for
104 # a list of builtin themes.
105 html_theme = 'default'
106
107 # Theme options are theme-specific and customize the look and feel of a theme
108 # further. For a list of options available for each theme, see the
109 # documentation.
110 #html_theme_options = {}
111
112 # Add any paths that contain custom themes here, relative to this directory.
113 #html_theme_path = []
114
115 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
116
117 if not on_rtd:
118 html_theme = 'sphinx_rtd_theme'
119 html_theme_path = ["_themes"]
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 html_title.
126 #html_short_title = None
127
128 # The name of an image file (relative to this directory) to place at the top
129 # of the sidebar.
130 #html_logo = None
131
132 # The name of an image file (within the static path) to use as favicon of the
133 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
134 # pixels large.
135 html_favicon = ''
136
137 # Add any paths that contain custom static files (such as style sheets) here,
138 # relative to this directory. They are copied after the builtin static files,
139 # so a file named "default.css" will overwrite the builtin "default.css".
140 html_static_path = ['_static']
141
142 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143 # using the given strftime format.
144 #html_last_updated_fmt = '%b %d, %Y'
145
146 # If true, SmartyPants will be used to convert quotes and dashes to
147 # typographically correct entities.
148 #html_use_smartypants = True
149
150 # Custom sidebar templates, maps document names to template names.
151 #html_sidebars = {}
152
153 # Additional templates that should be rendered to pages, maps page names to
154 # template names.
155 #html_additional_pages = {}
156
157 # If false, no module index is generated.
158 #html_domain_indices = True
159
160 # If false, no index is generated.
161 #html_use_index = True
162
163 # If true, the index is split into individual pages for each letter.
164 #html_split_index = False
165
166 # If true, links to the reST sources are added to the pages.
167 html_show_sourcelink = False
168
169 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170 #html_show_sphinx = True
171
172 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173 #html_show_copyright = True
174
175 # If true, an OpenSearch description file will be output, and all pages will
176 # contain a <link> tag referring to it. The value of this option must be the
177 # base URL from which the finished HTML is served.
178 #html_use_opensearch = ''
179
180 # This is the file name suffix for HTML files (e.g. ".xhtml").
181 #html_file_suffix = None
182
183 # Output file base name for HTML help builder.
184 htmlhelp_basename = 'libmarias3'
185
186
187 # -- Options for LaTeX output --------------------------------------------------
188
189 # The paper size ('letter' or 'a4').
190 #latex_paper_size = 'letter'
191
192 # The font size ('10pt', '11pt' or '12pt').
193 #latex_font_size = '10pt'
194
195 # Grouping the document tree into LaTeX files. List of tuples
196 # (source start file, target name, title, author, documentclass [howto/manual]).
197 latex_documents = [
198 ('index', 'libmarias3.tex', u'libmarias3 Documentation',
199 u'Andrew Hutchings', 'manual'),
200 ]
201
202 # The name of an image file (relative to this directory) to place at the top of
203 # the title page.
204 #latex_logo = None
205
206 # For "manual" documents, if this is true, then toplevel headings are parts,
207 # not chapters.
208 #latex_use_parts = False
209
210 # If true, show page references after internal links.
211 #latex_show_pagerefs = False
212
213 # If true, show URL addresses after external links.
214 #latex_show_urls = False
215
216 # Additional stuff for the LaTeX preamble.
217 #latex_preamble = ''
218
219 # Documents to append as an appendix to all manuals.
220 #latex_appendices = []
221
222 # If false, no module index is generated.
223 #latex_domain_indices = True
224
225
226 # -- Options for manual page output --------------------------------------------
227
228 # One entry per manual page. List of tuples
229
230 # (source start file, name, description, authors, manual section).
231 #man_show_urls=True
232 #man_pages = [
233 # ('bin/cxxflags', 'cxxflags', u'DDM4, http://tangent.org/', [u'Data Differential http://www.datadifferential.com/'], 1),
234 # ('bin/cflags', 'cflags', u'DDM4, http://tangent.org/', [u'Data Differential http://www.datadifferential.com/'], 1),
235 # ]