jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/855864 )

Change subject: [doc] Use 'furo' sphinx theme instead of 'natural' ......................................................................

[doc] Use 'furo' sphinx theme instead of 'natural'

- use html_theme = 'furo' - disable 'natural' html_sidebars - disable 'natural' html_style - use multiple processes to build distribution

Bug: T322212 Change-Id: Iba1020afd28fc8be164f3f097a946caf1021e2e8 --- M docs/conf.py M docs/requirements.txt M tox.ini 3 files changed, 10 insertions(+), 9 deletions(-)

Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified

diff --git a/docs/conf.py b/docs/conf.py index da8cdb2..b28e251 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -148,7 +148,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'nature' +html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -198,11 +198,12 @@

# Custom sidebar templates, maps document names to template names. # -html_sidebars = { - '**': [ - 'searchbox.html', 'localtoc.html', 'relations.html', 'sourcelink.html', - ] -} +# html_sidebars = { +# '**': [ +# 'searchbox.html', 'localtoc.html', 'relations.html', +# 'sourcelink.html', +# ] +# }

# Additional templates that should be rendered to pages, maps page names to # template names. @@ -376,7 +377,7 @@

# Pywikibot theme style html_permalinks_icon = '#' -html_style = 'css/pywikibot.css' +# html_style = 'css/pywikibot.css'

extlinks = { diff --git a/docs/requirements.txt b/docs/requirements.txt index ac449c1..e287d85 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 - +furo sphinx >= 5.2.3 rstcheck >=6.1.0 \ No newline at end of file diff --git a/tox.ini b/tox.ini index 8ef0770..c26452c 100644 --- a/tox.ini +++ b/tox.ini @@ -83,7 +83,7 @@

[testenv:doc] commands = - sphinx-build -M html ./docs ./docs/_build + sphinx-build -M html ./docs ./docs/_build -j auto rstcheck --version rstcheck -r --report-level WARNING --ignore-roles api,phab . basepython = python3.7