diff --git a/docs/conf.py b/docs/conf.py index 697b871..64f1243 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ # 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 @@ 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 @@ '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 0000000..8f95774 --- /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