# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'TileDB', 'TileDB Documentation', author, 'TileDB',
'One line description of project.', 'Miscellaneous'),
]
# -- Custom Document processing ----------------------------------------------
# Generate the sidebar automatically so that it is identical across all subprojects.
# This (and gensidebar.py) from https://github.com/robotpy/robotpy-docs
import gensidebar
gensidebar.generate_sidebar({
'on_rtd': readthedocs,
'rtd_version': rtd_version
}, 'tiledb')
# Replace C/C++ source examples path
def replaceText(app, docname, source):
result = source[0]
for key in app.config.text_replacements:
result = result.replace(key, app.config.text_replacements[key])
source[0] = result
text_replacements = {
"{source_examples_path}":
"../../examples",
"{tiledb_src_root_url}":
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'RobotPy WPILib'
epub_author = 'RobotPy development team'
epub_publisher = 'RobotPy development team'
epub_copyright = '2014, RobotPy development team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'wpilib')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith('wpilib.') and text.endswith('.'):
"tensorflow", "sklearn", "skimage", "nbformat", "cv2", "keras_retinanet",
"keras_maskrcnn"
]
# -- Options for intersphinx extension ---------------------------------------
intersphinx_mapping = {
'deepcell':
('https://deepcell.readthedocs.io/en/{}/'.format(rtd_version), None),
'redis_consumer':
('https://deepcell-kiosk.readthedocs.io/projects/kiosk-redis-consumer/en/{}/'
.format(rtd_version), None)
}
intersphinx_cache_limit = 0
# -- Options for todo extension ----------------------------------------------
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True
# -- Options for autosectionlabel extension ---------------------------------
autosectionlabel_prefix_document = True
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "deepcell-kiosk", True)
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "RobotPy"
epub_author = "RobotPy development team"
epub_publisher = "RobotPy development team"
epub_copyright = "2014-2020, RobotPy development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "robotpy")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith("wpilib.") and text.endswith("."):
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "MLBench Core"
epub_author = "MLBench development team"
epub_publisher = "MLBench development team"
epub_copyright = "2018, MLBench development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar # isort:skip
gensidebar.generate_sidebar(globals(), "mlbench_core")
import sphinx.addnodes # isort:skip
import docutils.nodes # isort:skip
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'networktables', 'RobotPy networktables Documentation',
['RobotPy Development Team'], 1)]
# -- 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', 'networktables', 'RobotPy networktables Documentation',
'RobotPy Development Team', 'networktables',
'One line description of project.', 'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'RobotPy NetworkTables'
epub_author = 'RobotPy Development Team'
epub_publisher = 'RobotPy Development Team'
epub_copyright = '2014, RobotPy Development Team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'pynetworktables')
# -- 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', 'pyfrc', 'pyfrc Documentation',
'Dustin Spicuzza', 'pyfrc', 'One line description of project.',
'Miscellaneous'),
]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'pyfrc')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith('wpilib.') and text.endswith('.'):
# remove the last element
# 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 = [
(master_doc, 'rtd-main.tex', u'rtd-main Documentation', u'Pierre',
'manual'),
]
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [(master_doc, 'rtd-main', u'rtd-main Documentation', [author], 1)]
# -- 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 = [
(master_doc, 'rtd-main', u'rtd-main Documentation', author, 'rtd-main',
'One line description of project.', 'Miscellaneous'),
]
# -- Custom
import gensidebar
gensidebar.generate_sidebar(globals(), 'rtd-main')
# -- 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', 'pyfrc', 'pyfrc Documentation',
'Dustin Spicuzza', 'pyfrc', 'One line description of project.',
'Miscellaneous'),
]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'pyfrc')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith('wpilib.') and text.endswith('.'):
# remove the last element
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
renku_python_version = version
if renku_python_version not in ["stable", "latest"]:
# tag build, update respective renku-python as well
with open("../helm-chart/renku/requirements.yaml", "r") as f:
requirements = yaml.load(f)
renku_core_entry = next(
(d for d in requirements["dependencies"] if d["name"] == "renku-core"),
None)
renku_python_version = "v{}".format(renku_core_entry["version"])
# retrigger build of renku-python docs so they point to the correct version
token = os.environ.get("RTD_TOKEN")
r = requests.post(
f"https://readthedocs.org/api/v3/projects/renku-python/versions/{renku_python_version}/builds/",
headers={"Authorization": f"Token {token}"},
)
r.raise_for_status()
intersphinx_mapping = {
"python": ("https://docs.python.org/", None),
}
# -- Custom Document processing ----------------------------------------------
from gensidebar import generate_sidebar
generate_sidebar(on_rtd, renku_python_version, "renku")
# 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",
"sphinx",
". Documentation",
"Author",
"sphinx",
"One line description of project.",
"Miscellaneous",
)]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "."
epub_author = "Author"
epub_publisher = "Author"
epub_copyright = "2015, Author"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "navx")
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'sphinx', '. Documentation', ['Author'], 1)]
# -- 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', 'sphinx', '. Documentation', 'Author', 'sphinx',
'One line description of project.', 'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = '.'
epub_author = 'Author'
epub_publisher = 'Author'
epub_copyright = '2015, Author'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'navx')
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
"index",
"networktables",
"RobotPy networktables Documentation",
"RobotPy Development Team",
"networktables",
"One line description of project.",
"Miscellaneous",
)
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "RobotPy NetworkTables"
epub_author = "RobotPy Development Team"
epub_publisher = "RobotPy Development Team"
epub_copyright = "2014, RobotPy Development Team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "pynetworktables")
# 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",
"sphinx",
". Documentation",
"Author",
"sphinx",
"One line description of project.",
"Miscellaneous",
)]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "."
epub_author = "Author"
epub_publisher = "Author"
epub_copyright = "2017, Author"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "rev")
# Add custom CSS to resize the tables
def setup(app):
app.add_stylesheet('css/theme_overrides.css')
#interlink mapping
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
# This is used for linking and such so we link to the thing we're building
rtd_version = os.environ.get('READTHEDOCS_VERSION', 'latest')
if rtd_version not in ['stable', 'latest']:
rtd_version = 'stable'
intersphinx_mapping = {
'user': ('http://openimis.readthedocs.io/en/%s/' % rtd_version, None),
'install':
('http://openimis-install.readthedocs.io/en/%s/' % rtd_version, None),
}
## Local and internalization
locale_dirs = ['locale/'] # path is example but recommended.
gettext_compact = False # optional.
## Gen menu
import gensidebar
gensidebar.generate_sidebar(globals(), "openIMIS")
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'RobotPy WPILib'
epub_author = 'RobotPy development team'
epub_publisher = 'RobotPy development team'
epub_copyright = '2014, RobotPy development team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'wpilib')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith('wpilib.') and text.endswith('.'):
# remove the last element
['Author'], 1)
]
# -- 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', 'sphinx', '. Documentation',
'Author', 'sphinx', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = '.'
epub_author = 'Author'
epub_publisher = 'Author'
epub_copyright = '2015, Author'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'utilities')
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'MLBench Benchmarks'
epub_author = 'MLBench development team'
epub_publisher = 'MLBench development team'
epub_copyright = '2018, MLBench development team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'mlbench_benchmarks')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
# Edit literals to be nicer
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'RobotPy'
epub_author = 'RobotPy development team'
epub_publisher = 'RobotPy development team'
epub_copyright = '2014-2016, RobotPy development team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'robotpy')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith('wpilib.') and text.endswith('.'):
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "MLBench Dashboard"
epub_author = "MLBench development team"
epub_publisher = "MLBench development team"
epub_copyright = "2018, MLBench development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "mlbench_dashboard")
import docutils.nodes
import sphinx.addnodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = 'MLBench'
epub_author = 'MLBench development team'
epub_publisher = 'MLBench development team'
epub_copyright = '2014-2016, MLBench development team'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'mlbench')
import sphinx.addnodes
import docutils.nodes
def process_child(node):
'''This function changes class references to not have the
intermediate module name by hacking at the doctree'''
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
(
"index",
"pyfrc",
"pyfrc Documentation",
"Dustin Spicuzza",
"pyfrc",
"One line description of project.",
"Miscellaneous",
)
]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "pyfrc")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith("wpilib.") and text.endswith("."):
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(
"index",
"sphinx",
". Documentation",
"Author",
"sphinx",
"One line description of project.",
"Miscellaneous",
)
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "."
epub_author = "Author"
epub_publisher = "Author"
epub_copyright = "2015, Author"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "utilities")
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [('index', 'sphinx', '. Documentation', ['Author'], 1)]
# -- 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', 'sphinx', '. Documentation', 'Author', 'sphinx',
'One line description of project.', 'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = '.'
epub_author = 'Author'
epub_publisher = 'Author'
epub_copyright = '2015, Author'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'utilities')
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "MLBench Benchmarks"
epub_author = "MLBench development team"
epub_publisher = "MLBench development team"
epub_copyright = "2018, MLBench development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "mlbench_benchmarks")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Extension configuration -------------------------------------------------
autodoc_mock_imports = [
"cv2", "keras_retinanet", "keras_preprocessing", "deepcell_tracking",
"deepcell_toolbox", "numpy", "scipy", "PIL"
]
# -- Options for intersphinx extension ---------------------------------------
intersphinx_mapping = {
'deepcell':
('https://deepcell.readthedocs.io/en/{}/'.format(rtd_version), None),
'kiosk':
('https://deepcell-kiosk.readthedocs.io/en/{}/'.format(rtd_version), None)
}
intersphinx_cache_limit = 0
# -- Custom Document processing ----------------------------------------------
# Download gensidebar
urlretrieve(
'https://raw.githubusercontent.com/vanvalenlab/kiosk/{}/docs/source/gensidebar.py'
.format(rtd_version), 'gensidebar.py')
import gensidebar
gensidebar.generate_sidebar(globals(), "kiosk-redis-consumer", hidden=False)
('index', 'sphinx', '. Documentation',
['Author'], 1)
]
# -- 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', 'sphinx', '. Documentation',
'Author', 'sphinx', 'One line description of project.',
'Miscellaneous'),
]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = '.'
epub_author = 'Author'
epub_publisher = 'Author'
epub_copyright = '2017, Author'
# A list of files that should not be packed into the epub file.
epub_exclude_files = ['search.html']
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), 'ctre')
# dir menu entry, description, category)
texinfo_documents = [(
"index",
"pyfrc",
"pyfrc Documentation",
"Dustin Spicuzza",
"pyfrc",
"One line description of project.",
"Miscellaneous",
)]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "pyfrc")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith("wpilib.") and text.endswith("."):
# 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",
"networktables",
"RobotPy networktables Documentation",
"RobotPy Development Team",
"networktables",
"One line description of project.",
"Miscellaneous",
)]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "RobotPy NetworkTables"
epub_author = "RobotPy Development Team"
epub_publisher = "RobotPy Development Team"
epub_copyright = "2014, RobotPy Development Team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "pynetworktables")
# 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",
"sphinx",
". Documentation",
"Author",
"sphinx",
"One line description of project.",
"Miscellaneous",
)]
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "."
epub_author = "Author"
epub_publisher = "Author"
epub_copyright = "2017, Author"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "ctre")
# epub_fix_images = False
# Scale large images.
# epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# epub_show_urls = 'inline'
# If false, no index is generated.
# epub_use_index = True
numfig = True
# Configuration for intersphinx
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'iris': ('https://scitools.org.uk/iris/docs/latest/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
'esmvaltool':
('https://docs.esmvaltool.org/en/%s/' % rtd_version, None),
'esmvalcore':
('https://docs.esmvaltool.org/projects/esmvalcore/en/%s/' %
rtd_version, None),
}
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "esmvaltool")
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "RobotPy WPILib"
epub_author = "RobotPy development team"
epub_publisher = "RobotPy development team"
epub_copyright = "2014, RobotPy development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "wpilib")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith("wpilib.") and text.endswith("."):
# Scale large images.
# epub_max_image_width = 0
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# epub_show_urls = 'inline'
# If false, no index is generated.
# epub_use_index = True
numfig = True
# Configuration for intersphinx
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'iris': ('https://scitools.org.uk/iris/docs/latest/', None),
'numpy': ('https://docs.scipy.org/doc/numpy/', None),
'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None),
'esmvaltool': ('https://docs.esmvaltool.org/en/%s/' % rtd_version, None),
'esmvalcore':
('https://docs.esmvaltool.org/projects/ESMValCore/en/%s/' % rtd_version,
None),
}
# -- Custom Document processing ----------------------------------------------
sys.path.append(os.path.dirname(__file__))
from gensidebar import generate_sidebar
generate_sidebar(globals(), "esmvalcore")
# -- Options for Epub output ----------------------------------------------
# Bibliographic Dublin Core info.
epub_title = "RobotPy WPILib"
epub_author = "RobotPy development team"
epub_publisher = "RobotPy development team"
epub_copyright = "2014, RobotPy development team"
# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]
# -- Custom Document processing ----------------------------------------------
import gensidebar
gensidebar.generate_sidebar(globals(), "wpilib")
import sphinx.addnodes
import docutils.nodes
def process_child(node):
"""This function changes class references to not have the
intermediate module name by hacking at the doctree"""
# Edit descriptions to be nicer
if isinstance(node, sphinx.addnodes.desc_addname):
if len(node.children) == 1:
child = node.children[0]
text = child.astext()
if text.startswith("wpilib.") and text.endswith("."):
