mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 21:09:03 +02:00
52c71e41d4
The default PDF output shows only chapter headings in the table of contents and in the outline (aka PDF bookmarks). We should override these defaults to set something more suitable. With a depth of 2 for the TOC we see both section and subsection headings which is enough to get the list of classes in the reference manual and the list of topics under "Common Tasks" in the development manual. Going to a deeper level would make the TOC unwieldy but we do want to make sure we can navigate more precisely using the outline (commonly shown in a left tab in PDF viewers) so we set the depth to 5 for the outline. (From yocto-docs rev: 5db16d3b01da0a138b6413347fcf2321a1bfae08) Signed-off-by: Paul Barker <pbarker@konsulko.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
132 lines
4.4 KiB
Python
132 lines
4.4 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# SPDX-License-Identifier: CC-BY-SA-2.0-UK
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# 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.
|
|
#
|
|
import os
|
|
import sys
|
|
import datetime
|
|
|
|
current_version = "dev"
|
|
|
|
# String used in sidebar
|
|
version = 'Version: ' + current_version
|
|
if current_version == 'dev':
|
|
version = 'Version: Current Development'
|
|
# Version seen in documentation_options.js and hence in js switchers code
|
|
release = current_version
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
project = 'The Yocto Project \xae'
|
|
copyright = '2010-%s, The Linux Foundation' % datetime.datetime.now().year
|
|
author = 'The Linux Foundation'
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# to load local extension from the folder 'sphinx'
|
|
sys.path.insert(0, os.path.abspath('sphinx'))
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
'sphinx.ext.autosectionlabel',
|
|
'sphinx.ext.extlinks',
|
|
'sphinx.ext.intersphinx',
|
|
'yocto-vars'
|
|
]
|
|
autosectionlabel_prefix_document = True
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'boilerplate.rst']
|
|
|
|
# master document name. The default changed from contents to index. so better
|
|
# set it ourselves.
|
|
master_doc = 'index'
|
|
|
|
# create substitution for project configuration variables
|
|
rst_prolog = """
|
|
.. |project_name| replace:: %s
|
|
.. |copyright| replace:: %s
|
|
.. |author| replace:: %s
|
|
""" % (project, copyright, author)
|
|
|
|
# external links and substitutions
|
|
extlinks = {
|
|
'yocto_home': ('https://yoctoproject.org%s', None),
|
|
'yocto_wiki': ('https://wiki.yoctoproject.org%s', None),
|
|
'yocto_dl': ('https://downloads.yoctoproject.org%s', None),
|
|
'yocto_lists': ('https://lists.yoctoproject.org%s', None),
|
|
'yocto_bugs': ('https://bugzilla.yoctoproject.org%s', None),
|
|
'yocto_ab': ('https://autobuilder.yoctoproject.org%s', None),
|
|
'yocto_docs': ('https://docs.yoctoproject.org%s', None),
|
|
'yocto_git': ('https://git.yoctoproject.org%s', None),
|
|
'oe_home': ('https://www.openembedded.org%s', None),
|
|
'oe_lists': ('https://lists.openembedded.org%s', None),
|
|
}
|
|
|
|
# Intersphinx config to use cross reference with Bitbake user manual
|
|
intersphinx_mapping = {
|
|
'bitbake': ('https://docs.yoctoproject.org/bitbake/', None)
|
|
}
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
try:
|
|
import sphinx_rtd_theme
|
|
html_theme = 'sphinx_rtd_theme'
|
|
html_theme_options = {
|
|
'sticky_navigation': False,
|
|
}
|
|
except ImportError:
|
|
sys.stderr.write("The Sphinx sphinx_rtd_theme HTML theme was not found.\
|
|
\nPlease make sure to install the sphinx_rtd_theme python package.\n")
|
|
sys.exit(1)
|
|
|
|
html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
|
|
|
|
# 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 = ['sphinx-static']
|
|
|
|
html_context = {
|
|
'current_version': current_version,
|
|
}
|
|
|
|
# Add customm CSS and JS files
|
|
html_css_files = ['theme_overrides.css']
|
|
html_js_files = ['switchers.js']
|
|
|
|
# Hide 'Created using Sphinx' text
|
|
html_show_sphinx = False
|
|
|
|
# Add 'Last updated' on each page
|
|
html_last_updated_fmt = '%b %d, %Y'
|
|
|
|
# Remove the trailing 'dot' in section numbers
|
|
html_secnumber_suffix = " "
|
|
|
|
latex_elements = {
|
|
'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
|
|
'preamble': '\setcounter{tocdepth}{2}',
|
|
}
|