source: rtems-docs/common/conf.py @ 3a71759

4.115am
Last change on this file since 3a71759 was 3a71759, checked in by Amar Takhar <amar@…>, on Jan 18, 2016 at 5:05:50 AM

Rework how conf.py is handled.

Needed to switch due to increasing complexity.

  • Property mode set to 100644
File size: 7.5 KB
Line 
1#import sys, os
2#sys.path.append(os.path.abspath('.'))
3#sys.path.append(os.path.abspath('../../common/'))
4
5
6extensions = [
7        "sphinx.ext.autodoc",
8        "sphinx.ext.coverage",
9        "sphinx.ext.doctest",
10        "sphinx.ext.graphviz",
11        "sphinx.ext.intersphinx",
12        "sphinx.ext.pngmath",
13        "rtemsext",
14        "rtemsdomain",
15]
16
17# Add any paths that contain templates here, relative to this directory.
18templates_path = ['build/_templates']
19
20# The suffix of source filenames.
21source_suffix = '.rst'
22
23# The encoding of source files.
24#source_encoding = 'utf-8-sig'
25
26# The master toctree document.
27master_doc = 'index'
28
29# General information about the project.
30project = u'RTEMS Documentation Project'
31copyright = u'2016, RTEMS Project'
32
33# The version info for the project you're documenting, acts as replacement for
34# |version| and |release|, also used in various other places throughout the
35# built documents.
36#
37# The short X.Y version.
38version = '@VERSION@'
39
40# The full version, including alpha/beta/rc tags.
41release = '@RELEASE@'
42
43# The language for content autogenerated by Sphinx. Refer to documentation
44# for a list of supported languages.
45#language = None
46
47# There are two options for replacing |today|: either, you set today to some
48# non-false value, then it is used:
49#today = ''
50# Else, today_fmt is used as the format for a strftime call.
51#today_fmt = '%B %d, %Y'
52
53# List of patterns, relative to source directory, that match files and
54# directories to ignore when looking for source files.
55exclude_patterns = []
56
57# The reST default role (used for this markup: `text`) to use for all documents.
58#default_role = None
59
60# If true, '()' will be appended to :func: etc. cross-reference text.
61#add_function_parentheses = True
62
63# If true, the current module name will be prepended to all description
64# unit titles (such as .. function::).
65#add_module_names = True
66
67# If true, sectionauthor and moduleauthor directives will be shown in the
68# output. They are ignored by default.
69#show_authors = False
70
71# The name of the Pygments (syntax highlighting) style to use.
72pygments_style = 'sphinx'
73
74# A list of ignored prefixes for module index sorting.
75#modindex_common_prefix = []
76
77
78# -- Options for HTML output ---------------------------------------------------
79
80# The theme to use for HTML and HTML Help pages.  See the documentation for
81# a list of builtin themes.
82
83import sphinx_rtd_theme
84html_theme = "sphinx_rtd_theme"
85html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
86
87# Theme options are theme-specific and customize the look and feel of a theme
88# further.  For a list of options available for each theme, see the
89# documentation.
90#html_theme_options = {}
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.
147#html_show_sourcelink = True
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 = [
173        ('index', '@FILE_DOC@.tex', u'RTEMS @DOC@ Documentation', u'RTEMS Documentation Project', 'manual'),
174]
175
176# Additional stuff for LaTeX
177latex_elements = {
178    'fontpkg':      r'\usepackage{mathpazo}',
179    'papersize':    'a4paper',
180    'pointsize':    '12pt',
181    'preamble':     r'''
182\usepackage{rtemsstyle}
183
184% i hate you latex, here too
185\DeclareUnicodeCharacter{2603}{\\N\{SNOWMAN\}}
186'''
187}
188
189latex_use_parts = True
190
191latex_additional_files = ['rtems.sty', 'logo.pdf']
192
193latex_use_modindex = False
194
195
196
197
198# The name of an image file (relative to this directory) to place at the top of
199# the title page.
200#latex_logo = None
201
202# For "manual" documents, if this is true, then toplevel headings are parts,
203# not chapters.
204#latex_use_parts = False
205
206# If true, show page references after internal links.
207#latex_show_pagerefs = False
208
209# If true, show URL addresses after external links.
210#latex_show_urls = False
211
212# Documents to append as an appendix to all manuals.
213#latex_appendices = []
214
215# If false, no module index is generated.
216#latex_domain_indices = True
217
218
219# -- Options for manual page output --------------------------------------------
220
221# One entry per manual page. List of tuples
222# (source start file, name, description, authors, manual section).
223man_pages = [
224        ('index', '@FILE_DOC@', u'RTEMS @DOC@ Documentation', [u'RTEMS Documentation Project'], 1)
225]
226
227# If true, show URL addresses after external links.
228#man_show_urls = False
229
230
231# -- Options for Texinfo output ------------------------------------------------
232
233# Grouping the document tree into Texinfo files. List of tuples
234# (source start file, target name, title, author,
235#  dir menu entry, description, category)
236texinfo_documents = [
237        ('index', '@FILE_DOC@', u'RTEMS @DOC@ Documentation', u'RTEMS Documentation Project', 'RTEMSwafBuild', 'RTEMS', 'Miscellaneous'),
238]
239
240# Documents to append as an appendix to all manuals.
241#texinfo_appendices = []
242
243# If false, no module index is generated.
244#texinfo_domain_indices = True
245
246# How to display URL addresses: 'footnote', 'no', or 'inline'.
247#texinfo_show_urls = 'footnote'
248
249
250# Example configuration for intersphinx: refer to the Python standard library.
251intersphinx_mapping = {'http://docs.python.org/': None}
252
253highlight_language = "c"
Note: See TracBrowser for help on using the repository browser.