jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/853266 )
Change subject: [sphinx] hide object path in Sphinx ......................................................................
[sphinx] hide object path in Sphinx
Change-Id: Ia51160b91b45c4291bc4105d772fe0fedfde0133 --- M docs/conf.py M docs/requirements.txt 2 files changed, 3 insertions(+), 2 deletions(-)
Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified
diff --git a/docs/conf.py b/docs/conf.py index 40f4cfd..da8cdb2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,7 +43,7 @@
# If your documentation needs a minimal Sphinx version, state it here. # -needs_sphinx = '5.1.1' +needs_sphinx = '5.2.3'
# Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -367,6 +367,7 @@ autodoc_typehints = 'description' # autosectionlabel_prefix_document = True suppress_warnings = ['autosectionlabel.*'] +toc_object_entries_show_parents = 'hide'
# Allow lines like "Example:" to be followed by a code block napoleon_use_admonition_for_examples = True diff --git a/docs/requirements.txt b/docs/requirements.txt index 53d9a1f..57f3cda 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ # This is a PIP requirements file for building Sphinx documentation of pywikibot # requirements.txt is also needed
-sphinx >= 5.1.1 +sphinx >= 5.2.3 rstcheck >=3.5.0 \ No newline at end of file