source: rtems-docs/common/conf.py @ 3202e31

5am
Last change on this file since 3202e31 was 3202e31, checked in by Sebastian Huber <sebastian.huber@…>, on 01/04/19 at 10:02:45

Replace build date with Git hash and commit date

The usage of a build date prevents reproducible builds.

  • Property mode set to 100644
File size: 6.4 KB
Line 
1extensions = [
2        "sphinx.ext.autodoc",
3        "sphinx.ext.coverage",
4        "sphinx.ext.doctest",
5        "sphinx.ext.graphviz",
6        "sphinx.ext.intersphinx",
7        "sphinx.ext.mathjax",
8        "sphinxcontrib.bibtex",
9        "rtemsext",
10        "rtemsdomain",
11]
12
13# Add any paths that contain templates here, relative to this directory.
14#templates_path = ['build/_templates']
15
16# The suffix of source filenames.
17source_suffix = '.rst'
18
19# The encoding of source files.
20#source_encoding = 'utf-8-sig'
21
22# The master toctree document.
23master_doc = 'index'
24
25# General information about the project.
26project = u'RTEMS Documentation Project'
27copyright = u'2018, RTEMS Project'
28
29# The version info for the project you're documenting, acts as replacement for
30# |version| and |release|, also used in various other places throughout the
31# built documents.
32#
33# The short X.Y version.
34#version = '@VERSION@'
35
36# The full version, including alpha/beta/rc tags.
37#release = '@RELEASE@'
38
39# The language for content autogenerated by Sphinx. Refer to documentation
40# for a list of supported languages.
41#language = None
42
43# There are two options for replacing |today|: either, you set today to some
44# non-false value, then it is used:
45#today = ''
46# Else, today_fmt is used as the format for a strftime call.
47#today_fmt = '%B %d, %Y'
48
49# List of patterns, relative to source directory, that match files and
50# directories to ignore when looking for source files.
51exclude_patterns = []
52
53# The reST default role (used for this markup: `text`) to use for all documents.
54#default_role = None
55
56# If true, '()' will be appended to :func: etc. cross-reference text.
57#add_function_parentheses = True
58
59# If true, the current module name will be prepended to all description
60# unit titles (such as .. function::).
61#add_module_names = True
62
63# If true, sectionauthor and moduleauthor directives will be shown in the
64# output. They are ignored by default.
65#show_authors = False
66
67# The name of the Pygments (syntax highlighting) style to use.
68pygments_style = 'sphinx'
69
70# A list of ignored prefixes for module index sorting.
71#modindex_common_prefix = []
72
73# -- Options for HTML output ---------------------------------------------------
74
75# The theme to use for HTML and HTML Help pages.  See the documentation for
76# a list of builtin themes.
77
78import sphinx_rtd_theme_rtems
79html_theme = "sphinx_rtd_theme_rtems"
80html_theme_path = [sphinx_rtd_theme_rtems.get_html_theme_path()]
81
82# Theme options are theme-specific and customize the look and feel of a theme
83# further.  For a list of options available for each theme, see the
84# documentation.
85html_theme_options = {
86    'collapse_navigation': False,
87    'display_version': True,
88    'sticky_navigation': True,
89    'genindex': True,
90}
91
92# Add any paths that contain custom themes here, relative to this directory.
93#html_theme_path = []
94
95# The name for this set of Sphinx documents.  If None, it defaults to
96# "<project> v<release> documentation".
97#html_title = None
98
99# A shorter title for the navigation bar.  Default is the same as html_title.
100#html_short_title = None
101
102# The name of an image file (relative to this directory) to place at the top
103# of the sidebar.
104#html_logo = None
105
106# The name of an image file (within the static path) to use as favicon of the
107# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
108# pixels large.
109#html_favicon = None
110
111# Add any paths that contain custom static files (such as style sheets) here,
112# relative to this directory. They are copied after the builtin static files,
113# so a file named "default.css" will overwrite the builtin "default.css".
114html_static_path = ['build/_static']
115
116# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
117# using the given strftime format.
118#html_last_updated_fmt = '%b %d, %Y'
119
120# If true, SmartyPants will be used to convert quotes and dashes to
121# typographically correct entities.
122#html_use_smartypants = True
123
124# Custom sidebar templates, maps document names to template names.
125#html_sidebars = {}
126
127html_sidebars = {
128#       'index':    ['sidebarlogo.html', 'sidebarintro.html', 'sourcelink.html','searchbox.html'],
129#       '**':       ['sidebarlogo.html', 'localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']
130}
131
132
133# Additional templates that should be rendered to pages, maps page names to
134# template names.
135#html_additional_pages = {}
136
137# If false, no module index is generated.
138#html_domain_indices = True
139
140# If false, no index is generated.
141#html_use_index = True
142
143# If true, the index is split into individual pages for each letter.
144#html_split_index = False
145
146# If true, links to the reST sources are added to the pages.
147html_show_sourcelink = False
148
149# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
150#html_show_sphinx = True
151
152# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
153#html_show_copyright = True
154
155# If true, an OpenSearch description file will be output, and all pages will
156# contain a <link> tag referring to it.  The value of this option must be the
157# base URL from which the finished HTML is served.
158#html_use_opensearch = ''
159
160# This is the file name suffix for HTML files (e.g. ".xhtml").
161#html_file_suffix = None
162
163# Output file base name for HTML help builder.
164htmlhelp_basename = 'rtemsdoc'
165
166
167# -- Options for LaTeX output --------------------------------------------------
168latex_paper_size = 'a4'
169
170# Grouping the document tree into LaTeX files. List of tuples
171# (source start file, target name, title, author, documentclass [howto/manual]).
172latex_documents = [] # must be overridden in local conf.py
173
174# Additional stuff for LaTeX
175#    'fontpkg':      r'\usepackage{mathpazo}',
176latex_elements = {
177    'papersize':    'a4paper',
178    'pointsize':    '11pt',
179    'preamble':     r'''
180\newcommand{\rtemscopyright}{%s}
181\usepackage{rtemsstyle}
182''' % (copyright),
183    'parsedliteralwraps': True,
184}
185
186
187latex_additional_files = ['../common/rtemsstyle.sty', '../common/minted.sty', '../common/logo.pdf']
188latex_use_modindex = False
189
190
191# The name of an image file (relative to this directory) to place at the top of
192# the title page.
193#latex_logo = None
194
195# If true, show page references after internal links.
196latex_show_pagerefs = False
197
198# If true, show URL addresses after external links.
199#latex_show_urls=True
200
201# Documents to append as an appendix to all manuals.
202#latex_appendices = []
203
204# If false, no module index is generated.
205#latex_domain_indices = True
206
207
208# Example configuration for intersphinx: refer to the Python standard library.
209#intersphinx_mapping = {'http://docs.python.org/': None}
210
211highlight_language = "c"
Note: See TracBrowser for help on using the repository browser.