2016-10-23 20:14:24 +00:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
#
|
|
|
|
# Read the Docs Template documentation build configuration file, created by
|
|
|
|
# sphinx-quickstart on Tue Aug 26 14:19:49 2014.
|
|
|
|
#
|
|
|
|
# This file is execfile()d with the current directory set to its
|
|
|
|
# containing dir.
|
|
|
|
#
|
|
|
|
# Note that not all possible configuration values are present in this
|
|
|
|
# autogenerated file.
|
|
|
|
#
|
|
|
|
# All configuration values have a default; values that are commented out
|
|
|
|
# serve to show the default.
|
|
|
|
|
2017-05-02 08:36:01 +00:00
|
|
|
import sys, os
|
2017-01-19 08:16:06 +00:00
|
|
|
import re
|
|
|
|
from subprocess import call, Popen, PIPE
|
|
|
|
import shlex
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
2017-01-19 08:16:06 +00:00
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
2016-10-23 20:14:24 +00:00
|
|
|
|
docs: speed up incremental builds
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-05 12:12:52 +00:00
|
|
|
from local_util import run_cmd_get_output, copy_if_modified
|
|
|
|
|
|
|
|
builddir = '_build'
|
|
|
|
if 'BUILDDIR' in os.environ:
|
|
|
|
builddir = os.environ['BUILDDIR']
|
2016-10-24 18:43:13 +00:00
|
|
|
|
2017-05-02 08:36:01 +00:00
|
|
|
# Call Doxygen to get XML files from the header files
|
|
|
|
print "Calling Doxygen to generate latest XML files"
|
2016-10-23 20:14:24 +00:00
|
|
|
call('doxygen')
|
docs: speed up incremental builds
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-05 12:12:52 +00:00
|
|
|
# Doxygen has generated XML files in 'xml' directory.
|
|
|
|
# Copy them to 'xml_in', only touching the files which have changed.
|
|
|
|
copy_if_modified('xml/', 'xml_in/')
|
|
|
|
|
2017-05-02 08:36:01 +00:00
|
|
|
# Generate 'api_name.inc' files using the XML files by Doxygen
|
docs: speed up incremental builds
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-05 12:12:52 +00:00
|
|
|
os.system('python gen-dxd.py')
|
|
|
|
|
2017-08-20 16:09:12 +00:00
|
|
|
# Generate 'kconfig.inc' file from components' Kconfig files
|
docs: speed up incremental builds
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-05 12:12:52 +00:00
|
|
|
kconfig_inc_path = '{}/inc/kconfig.inc'.format(builddir)
|
|
|
|
os.system('python gen-kconfig-doc.py > ' + kconfig_inc_path + '.in')
|
|
|
|
copy_if_modified(kconfig_inc_path + '.in', kconfig_inc_path)
|
2017-05-02 08:36:01 +00:00
|
|
|
|
|
|
|
# http://stackoverflow.com/questions/12772927/specifying-an-online-image-in-sphinx-restructuredtext-format
|
|
|
|
#
|
|
|
|
suppress_warnings = ['image.nonlocal_uri']
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# -- General configuration ------------------------------------------------
|
|
|
|
|
|
|
|
# If your documentation needs a minimal Sphinx version, state it here.
|
|
|
|
#needs_sphinx = '1.0'
|
|
|
|
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
|
|
# ones.
|
2017-11-06 20:41:31 +00:00
|
|
|
extensions = ['breathe',
|
|
|
|
'link-roles',
|
|
|
|
'sphinxcontrib.blockdiag',
|
|
|
|
'sphinxcontrib.seqdiag',
|
|
|
|
'sphinxcontrib.actdiag',
|
|
|
|
'sphinxcontrib.nwdiag',
|
|
|
|
'sphinxcontrib.rackdiag',
|
|
|
|
'sphinxcontrib.packetdiag'
|
|
|
|
]
|
|
|
|
|
|
|
|
# Set up font for blockdiag, nwdiag, rackdiag and packetdiag
|
|
|
|
blockdiag_fontpath = '_static/DejaVuSans.ttf'
|
|
|
|
seqdiag_fontpath = '_static/DejaVuSans.ttf'
|
|
|
|
actdiag_fontpath = '_static/DejaVuSans.ttf'
|
|
|
|
nwdiag_fontpath = '_static/DejaVuSans.ttf'
|
|
|
|
rackdiag_fontpath = '_static/DejaVuSans.ttf'
|
|
|
|
packetdiag_fontpath = '_static/DejaVuSans.ttf'
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# Breathe extension variables
|
docs: speed up incremental builds
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.
With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.
Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).
Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
2018-03-05 12:12:52 +00:00
|
|
|
|
|
|
|
# Doxygen regenerates files in 'xml/' directory every time,
|
|
|
|
# but we copy files to 'xml_in/' only when they change, to speed up
|
|
|
|
# incremental builds.
|
|
|
|
breathe_projects = { "esp32-idf": "xml_in/" }
|
2016-10-23 20:14:24 +00:00
|
|
|
breathe_default_project = "esp32-idf"
|
|
|
|
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
|
|
templates_path = ['_templates']
|
|
|
|
|
|
|
|
# The suffix of source filenames.
|
2018-01-11 06:52:54 +00:00
|
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
|
|
|
|
source_parsers = {
|
|
|
|
'.md': 'recommonmark.parser.CommonMarkParser',
|
|
|
|
}
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# The encoding of source files.
|
|
|
|
#source_encoding = 'utf-8-sig'
|
|
|
|
|
|
|
|
# The master toctree document.
|
|
|
|
master_doc = 'index'
|
|
|
|
|
|
|
|
# General information about the project.
|
2017-01-17 19:37:27 +00:00
|
|
|
project = u'ESP-IDF Programming Guide'
|
|
|
|
copyright = u'2016 - 2017, Espressif'
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# The version info for the project you're documenting, acts as replacement for
|
|
|
|
# |version| and |release|, also used in various other places throughout the
|
|
|
|
# built documents.
|
|
|
|
#
|
2016-11-05 16:11:40 +00:00
|
|
|
|
2017-01-19 08:16:06 +00:00
|
|
|
# Readthedocs largely ignores 'version' and 'release', and displays one of
|
|
|
|
# 'latest', tag name, or branch name, depending on the build type.
|
|
|
|
# Still, this is useful for non-RTD builds.
|
|
|
|
# This is supposed to be "the short X.Y version", but it's the only version
|
|
|
|
# visible when you open index.html.
|
|
|
|
# Display full version to make things less confusing.
|
|
|
|
version = run_cmd_get_output('git describe')
|
|
|
|
# The full version, including alpha/beta/rc tags.
|
|
|
|
# If needed, nearest tag is returned by 'git describe --abbrev=0'.
|
|
|
|
release = version
|
|
|
|
print 'Version: {0} Release: {1}'.format(version, release)
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
|
|
# for a list of supported languages.
|
|
|
|
#language = None
|
|
|
|
|
|
|
|
# There are two options for replacing |today|: either, you set today to some
|
|
|
|
# non-false value, then it is used:
|
|
|
|
#today = ''
|
|
|
|
# Else, today_fmt is used as the format for a strftime call.
|
|
|
|
#today_fmt = '%B %d, %Y'
|
|
|
|
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
|
|
# directories to ignore when looking for source files.
|
2018-01-11 06:52:54 +00:00
|
|
|
exclude_patterns = ['_build','README.md']
|
2016-10-23 20:14:24 +00:00
|
|
|
|
|
|
|
# The reST default role (used for this markup: `text`) to use for all
|
|
|
|
# documents.
|
|
|
|
#default_role = None
|
|
|
|
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
|
|
#add_function_parentheses = True
|
|
|
|
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
|
|
# unit titles (such as .. function::).
|
|
|
|
#add_module_names = True
|
|
|
|
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
|
|
# output. They are ignored by default.
|
|
|
|
#show_authors = False
|
|
|
|
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
|
|
pygments_style = 'sphinx'
|
|
|
|
|
|
|
|
# A list of ignored prefixes for module index sorting.
|
|
|
|
#modindex_common_prefix = []
|
|
|
|
|
|
|
|
# If true, keep warnings as "system message" paragraphs in the built documents.
|
|
|
|
#keep_warnings = False
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output ----------------------------------------------
|
|
|
|
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
|
|
# a list of builtin themes.
|
|
|
|
html_theme = 'default'
|
|
|
|
|
|
|
|
# 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
|
|
|
|
# documentation.
|
|
|
|
#html_theme_options = {}
|
|
|
|
|
|
|
|
# Add any paths that contain custom themes here, relative to this directory.
|
|
|
|
#html_theme_path = []
|
|
|
|
|
|
|
|
# The name for this set of Sphinx documents. If None, it defaults to
|
|
|
|
# "<project> v<release> documentation".
|
|
|
|
#html_title = None
|
|
|
|
|
|
|
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
|
|
|
#html_short_title = None
|
|
|
|
|
|
|
|
# The name of an image file (relative to this directory) to place at the top
|
|
|
|
# of the sidebar.
|
|
|
|
#html_logo = None
|
|
|
|
|
|
|
|
# The name of an image file (within the static path) to use as favicon of the
|
|
|
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
|
|
|
# pixels large.
|
|
|
|
#html_favicon = None
|
|
|
|
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
|
|
html_static_path = ['_static']
|
|
|
|
|
|
|
|
# Add any extra paths that contain custom files (such as robots.txt or
|
|
|
|
# .htaccess) here, relative to this directory. These files are copied
|
|
|
|
# directly to the root of the documentation.
|
|
|
|
#html_extra_path = []
|
|
|
|
|
|
|
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
|
|
# using the given strftime format.
|
|
|
|
#html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
|
|
|
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
|
|
|
# typographically correct entities.
|
|
|
|
#html_use_smartypants = True
|
|
|
|
|
|
|
|
# Custom sidebar templates, maps document names to template names.
|
|
|
|
#html_sidebars = {}
|
|
|
|
|
|
|
|
# Additional templates that should be rendered to pages, maps page names to
|
|
|
|
# template names.
|
|
|
|
#html_additional_pages = {}
|
|
|
|
|
|
|
|
# If false, no module index is generated.
|
|
|
|
#html_domain_indices = True
|
|
|
|
|
|
|
|
# If false, no index is generated.
|
|
|
|
#html_use_index = True
|
|
|
|
|
|
|
|
# If true, the index is split into individual pages for each letter.
|
|
|
|
#html_split_index = False
|
|
|
|
|
|
|
|
# If true, links to the reST sources are added to the pages.
|
|
|
|
#html_show_sourcelink = True
|
|
|
|
|
|
|
|
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
|
|
|
#html_show_sphinx = True
|
|
|
|
|
|
|
|
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
|
|
|
#html_show_copyright = True
|
|
|
|
|
|
|
|
# If true, an OpenSearch description file will be output, and all pages will
|
|
|
|
# contain a <link> tag referring to it. The value of this option must be the
|
|
|
|
# base URL from which the finished HTML is served.
|
|
|
|
#html_use_opensearch = ''
|
|
|
|
|
|
|
|
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
|
|
|
#html_file_suffix = None
|
|
|
|
|
|
|
|
# Output file base name for HTML help builder.
|
|
|
|
htmlhelp_basename = 'ReadtheDocsTemplatedoc'
|
|
|
|
|
|
|
|
|
|
|
|
# -- Options for LaTeX output ---------------------------------------------
|
|
|
|
|
|
|
|
latex_elements = {
|
|
|
|
# The paper size ('letterpaper' or 'a4paper').
|
|
|
|
#'papersize': 'letterpaper',
|
|
|
|
|
|
|
|
# The font size ('10pt', '11pt' or '12pt').
|
|
|
|
#'pointsize': '10pt',
|
|
|
|
|
|
|
|
# Additional stuff for the LaTeX preamble.
|
|
|
|
#'preamble': '',
|
|
|
|
}
|
|
|
|
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
|
|
# (source start file, target name, title,
|
|
|
|
# author, documentclass [howto, manual, or own class]).
|
|
|
|
latex_documents = [
|
|
|
|
('index', 'ReadtheDocsTemplate.tex', u'Read the Docs Template Documentation',
|
|
|
|
u'Read the Docs', 'manual'),
|
|
|
|
]
|
|
|
|
|
|
|
|
# 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
|
|
|
|
|
|
|
|
# If true, show page references after internal links.
|
|
|
|
#latex_show_pagerefs = False
|
|
|
|
|
|
|
|
# If true, show URL addresses after external links.
|
|
|
|
#latex_show_urls = False
|
|
|
|
|
|
|
|
# Documents to append as an appendix to all manuals.
|
|
|
|
#latex_appendices = []
|
|
|
|
|
|
|
|
# If false, no module index is generated.
|
|
|
|
#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', 'readthedocstemplate', u'Read the Docs Template Documentation',
|
|
|
|
[u'Read the Docs'], 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', 'ReadtheDocsTemplate', u'Read the Docs Template Documentation',
|
|
|
|
u'Read the Docs', 'ReadtheDocsTemplate', 'One line description of project.',
|
|
|
|
'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'
|
|
|
|
|
|
|
|
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
|
|
|
#texinfo_no_detailmenu = False
|
2016-10-24 18:43:13 +00:00
|
|
|
|
|
|
|
# -- Use sphinx_rtd_theme for local builds --------------------------------
|
|
|
|
# ref. https://github.com/snide/sphinx_rtd_theme#using-this-theme-locally-then-building-on-read-the-docs
|
|
|
|
#
|
|
|
|
# on_rtd is whether we are on readthedocs.org
|
|
|
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
|
|
|
|
|
|
|
if not on_rtd: # only import and set the theme if we're building docs locally
|
|
|
|
import sphinx_rtd_theme
|
|
|
|
html_theme = 'sphinx_rtd_theme'
|
|
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
|
|
|
|
# otherwise, readthedocs.org uses their theme by default, so no need to specify it
|
2017-05-02 08:36:01 +00:00
|
|
|
|