summaryrefslogtreecommitdiff
path: root/conf.py
diff options
context:
space:
mode:
authorDan Halbert <halbert@halwitz.org>2017-08-25 22:17:07 -0400
committerDan Halbert <halbert@halwitz.org>2017-08-25 22:17:07 -0400
commitef61b5ecb59e9b4e37e3e3c023c62d583c23eb16 (patch)
tree45a798fbed0dc673304597b29e0b60174195ce79 /conf.py
parent266be307770abe11c220eb493388807920914b7a (diff)
parent1f78e7a43130acfa4bedf16c1007a1b0f37c75c3 (diff)
Initial merge of micropython v1.9.2 into circuitpython 2.0.0 (in development) master.
cpx build compiles and loads and works in repl; test suite not run yet esp8266 not tested yet
Diffstat (limited to 'conf.py')
-rw-r--r--conf.py18
1 files changed, 13 insertions, 5 deletions
diff --git a/conf.py b/conf.py
index 0e4922b31..42536368f 100644
--- a/conf.py
+++ b/conf.py
@@ -67,10 +67,9 @@ copyright = '2014-2017, MicroPython & CircuitPython contributors (https://github
# |version| and |release|, also used in various other places throughout the
# built documents.
#
-# The short X.Y version.
-version = '0.0'
-# The full version, including alpha/beta/rc tags.
-release = '0.0.0'
+# We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"
+# breakdown, so use the same version identifier for both to avoid confusion.
+version = release = '0.0.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -85,6 +84,7 @@ release = '0.0.0'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["*/build-*",
+ ".venv",
"atmel-samd/asf",
"atmel-samd/asf_conf",
"atmel-samd/common-hal",
@@ -122,7 +122,7 @@ exclude_patterns = ["*/build-*",
# The reST default role (used for this markup: `text`) to use for all
# documents.
-default_role = "any"
+default_role = 'any'
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
@@ -144,6 +144,12 @@ pygments_style = 'sphinx'
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
+# Global include files. Sphinx docs suggest using rst_epilog in preference
+# of rst_prolog, so we follow. Absolute paths below mean "from the base
+# of the doctree".
+rst_epilog = """
+.. include:: /templates/replace.inc
+"""
# -- Options for HTML output ----------------------------------------------
@@ -251,6 +257,8 @@ latex_elements = {
# Additional stuff for the LaTeX preamble.
#'preamble': '',
+# Include 3 levels of headers in PDF ToC
+'preamble': '\setcounter{tocdepth}{2}',
}
# Grouping the document tree into LaTeX files. List of tuples