diff options
| author | John Tsichritzis <john.tsichritzis@arm.com> | 2019-06-03 16:24:24 +0000 |
|---|---|---|
| committer | TrustedFirmware Code Review <review@review.trustedfirmware.org> | 2019-06-03 16:24:24 +0000 |
| commit | 49d969bbb3ca7e738bc6ef560e44c0047a9925cc (patch) | |
| tree | dba3aea15958eba2ff94272a378f1d5959e0e198 /docs | |
| parent | e30d1d779c6d2c28fec91633314a61ba31d87a33 (diff) | |
| parent | c4e4df35d0413693901e351bb0d668c10ce9cfaa (diff) | |
Merge "doc: Enable automatic labels for page titles" into integration
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 10 | ||||
| -rw-r--r-- | docs/requirements.txt | 2 |
2 files changed, 11 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py index 697b8711..64f12431 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['sphinx.ext.autosectionlabel'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -54,6 +54,9 @@ pygments_style = 'sphinx' with open('global_substitutions.txt', 'r') as subs: rst_prolog = subs.read() +# Minimum version of sphinx required +needs_sphinx = '2.0' + # -- Options for HTML output ------------------------------------------------- # Don't show the "Built with Sphinx" footer @@ -75,3 +78,8 @@ html_theme_options = { 'prev_next_buttons_location': 'both', # Top and bottom of the page '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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..8f95774b --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx>=2.0.0 +sphinx-rtd-theme>=0.4.3
\ No newline at end of file |