source: rtems-docs/common/conf.py @ 46498bd

4.115
Last change on this file since 46498bd was 46498bd, checked in by Amar Takhar <amar@…>, on Jan 18, 2016 at 3:28:28 AM

Fix rtemsconfig building.

I'll probably move to a more pythonic way of doing conf.py since this is getting
too complicated.

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