source: rtems-docs/common/conf.py @ 5daabd2

4.115
Last change on this file since 5daabd2 was 5daabd2, checked in by Amar Takhar <amar@…>, on Jan 16, 2016 at 4:41:06 AM

Initial reST documentation using Sphinx.

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