From e83d747fabf0ddb2b9e5c5264715246900b5de38 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Wed, 17 Jan 2024 16:30:16 +0000 Subject: [PATCH] Revert "docs: Switch to Furo" This reverts commit 859233b535c0e828af4214c69cf6c10156c643f1. The furo theme requires far more changes than this, and the RTD theme now supports Sphinx 5.x. Signed-off-by: Stephen Finucane --- docs/conf.py | 12 ++++++------ docs/contents.rst | 9 +++++++++ docs/index.rst | 10 ---------- docs/requirements.txt | 2 +- 4 files changed, 16 insertions(+), 17 deletions(-) create mode 100644 docs/contents.rst diff --git a/docs/conf.py b/docs/conf.py index 6371371..41912d0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,11 +1,11 @@ # pwclient documentation build configuration file try: - import furo # noqa + import sphinx_rtd_theme # noqa - has_furo_theme = True + has_rtd_theme = True except ImportError: - has_furo_theme = False + has_rtd_theme = False # -- General configuration ------------------------------------------------ @@ -18,7 +18,7 @@ ] # The master toctree document. -master_doc = 'index' +master_doc = 'contents' # General information about the project. project = 'pwclient' @@ -33,5 +33,5 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -if has_furo_theme: - html_theme = 'furo' +if has_rtd_theme: + html_theme = 'sphinx_rtd_theme' diff --git a/docs/contents.rst b/docs/contents.rst new file mode 100644 index 0000000..192d208 --- /dev/null +++ b/docs/contents.rst @@ -0,0 +1,9 @@ +Contents +======== + +.. toctree:: + + index + configuration + usage + release-notes diff --git a/docs/index.rst b/docs/index.rst index 6fcd2d3..61faad0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,13 +4,3 @@ pwclient .. include:: ../README.rst :start-line: 18 :end-line: -7 - -Documentation -------------- - -.. toctree:: - :maxdepth: 2 - - usage - configuration - release-notes diff --git a/docs/requirements.txt b/docs/requirements.txt index ec06f67..6988cf9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ sphinx reno -furo +sphinx_rtd_theme sphinxcontrib.autoprogram