summaryrefslogtreecommitdiffstats
path: root/common/conf.py
diff options
context:
space:
mode:
authorAmar Takhar <amar@rtems.org>2016-01-19 20:37:04 -0500
committerAmar Takhar <verm@darkbeer.org>2016-05-02 20:51:25 -0400
commita316b1ff6d765fe0d3631282e750c94470612e97 (patch)
tree577d0a4cd9659c9834d39eb944a9d662d4f6f2dd /common/conf.py
parent89f234787ed0f125e5947ee30f322007f4f0ed38 (diff)
downloadrtems-docs-a316b1ff6d765fe0d3631282e750c94470612e97.tar.bz2
Add support for singlehtml (inlined) HTML file, plus some other fixes.
* This is still broken. * Rename sphinx_rtd_theme so it doesn't pickup locally installed ones * Add a hack to theme.css to get around inliner bug. * Some unrelated fixups in common/waf.py Unfortunatly several dozen fixes got merged into this.
Diffstat (limited to 'common/conf.py')
-rw-r--r--common/conf.py58
1 files changed, 9 insertions, 49 deletions
diff --git a/common/conf.py b/common/conf.py
index ded57d1..f136779 100644
--- a/common/conf.py
+++ b/common/conf.py
@@ -80,9 +80,9 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-import sphinx_rtd_theme
-html_theme = "sphinx_rtd_theme"
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+import sphinx_rtd_theme_rtems
+html_theme = "sphinx_rtd_theme_rtems"
+html_theme_path = [sphinx_rtd_theme_rtems.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -169,45 +169,36 @@ latex_paper_size = 'a4'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
-latex_documents = [
- ('index', '@FILE_DOC@.tex', u'RTEMS @DOC@ Documentation', u'RTEMS Documentation Project', 'manual'),
-]
+latex_documents = [] # must be overridden in local conf.py
# Additional stuff for LaTeX
+# 'fontpkg': r'\usepackage{mathpazo}',
latex_elements = {
- 'fontpkg': r'\usepackage{mathpazo}',
'papersize': 'a4paper',
'pointsize': '12pt',
'preamble': r'''
\usepackage{rtemsstyle}
-
-% i hate you latex, here too
-\DeclareUnicodeCharacter{2603}{\\N\{SNOWMAN\}}
'''
}
-latex_use_parts = True
latex_additional_files = ['../common/rtemsstyle.sty', '../common/logo.pdf']
-
latex_use_modindex = False
-
-
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
-#latex_use_parts = False
+latex_use_parts = True
# If true, show page references after internal links.
-#latex_show_pagerefs = False
+latex_show_pagerefs = True
# If true, show URL addresses after external links.
-#latex_show_urls = False
+latex_show_urls=True
# Documents to append as an appendix to all manuals.
#latex_appendices = []
@@ -216,38 +207,7 @@ latex_use_modindex = False
#latex_domain_indices = True
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
- ('index', '@FILE_DOC@', u'RTEMS @DOC@ Documentation', [u'RTEMS Documentation Project'], 1)
-]
-
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- ('index', '@FILE_DOC@', u'RTEMS @DOC@ Documentation', u'RTEMS Documentation Project', 'RTEMSwafBuild', 'RTEMS', 'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-
# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {'http://docs.python.org/': None}
+#intersphinx_mapping = {'http://docs.python.org/': None}
highlight_language = "c"