Commit c4e4df35 authored by Paul Beesley's avatar Paul Beesley
Browse files

doc: Enable automatic labels for page titles



Automatic labelling of document titles is a prerequisite for
converting the format of cross-document links. Sphinx will
generate (via the enabled extension) a hidden link target for
each document title and this can be referred to later, from
another page, to link to the target.

The plugin options being used require Sphinx >= 2.0.0 so a
requirements.txt file has been added. This file is used with
the pip package manager for Python so that the correct
dependencies are installed.

Change-Id: Ic2049db5804aa4a6447608ba4299de958ce0a87d
Signed-off-by: default avatarPaul Beesley <paul.beesley@arm.com>
parent 84167417
...@@ -23,7 +23,7 @@ release = version # We don't need these to be distinct ...@@ -23,7 +23,7 @@ release = version # We don't need these to be distinct
# Add any Sphinx extension module names here, as strings. They can be # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [] extensions = ['sphinx.ext.autosectionlabel']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
...@@ -54,6 +54,9 @@ pygments_style = 'sphinx' ...@@ -54,6 +54,9 @@ pygments_style = 'sphinx'
with open('global_substitutions.txt', 'r') as subs: with open('global_substitutions.txt', 'r') as subs:
rst_prolog = subs.read() rst_prolog = subs.read()
# Minimum version of sphinx required
needs_sphinx = '2.0'
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# Don't show the "Built with Sphinx" footer # Don't show the "Built with Sphinx" footer
...@@ -75,3 +78,8 @@ html_theme_options = { ...@@ -75,3 +78,8 @@ html_theme_options = {
'prev_next_buttons_location': 'both', # Top and bottom of the page 'prev_next_buttons_location': 'both', # Top and bottom of the page
'style_external_links': True # Display an icon next to external links 'style_external_links': True # Display an icon next to external links
} }
# -- Options for autosectionlabel --------------------------------------------
# Only generate automatic section labels for document titles
autosectionlabel_maxdepth = 1
\ No newline at end of file
sphinx>=2.0.0
sphinx-rtd-theme>=0.4.3
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment