diff options
| author | Alberto Contreras <alberto.contreras@canonical.com> | 2022-11-14 19:00:22 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-14 11:00:22 -0700 |
| commit | c07453632d8f2c6f5885c437a331954a449b73cc (patch) | |
| tree | 8128b197a516847926cf99be6b37a5ddc2f5d689 | |
| parent | 1f43a83e15fd47fa2a6b5d3836bf6e055b956b89 (diff) | |
| download | cloud-init-git-c07453632d8f2c6f5885c437a331954a449b73cc.tar.gz | |
docs: switch sphinx theme to furo (SC-1327) (#1821)
| -rw-r--r-- | doc-requirements.txt | 13 | ||||
| -rw-r--r-- | doc/rtd/conf.py | 13 | ||||
| -rw-r--r-- | doc/rtd/static/logo-dark-mode.png | bin | 0 -> 17483 bytes | |||
| -rw-r--r-- | doc/rtd/topics/modules.rst | 1 |
4 files changed, 11 insertions, 16 deletions
diff --git a/doc-requirements.txt b/doc-requirements.txt index 3207e6c6..6f48062e 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -1,11 +1,6 @@ -# doc8 1.0.0 depends on docutils 0.18.1 or later which added Node.findall() -doc8==0.11.2 +doc8 +furo m2r2 -sphinx==4.3.0 -sphinx_rtd_theme==1.0.0 pyyaml -sphinx-panels - -# Indirect dependencies -jinja2<3.1.0 # https://github.com/readthedocs/readthedocs.org/issues/9037 -docutils==0.16 # https://github.com/readthedocs/sphinx_rtd_theme/issues/1115 +sphinx +sphinx-design diff --git a/doc/rtd/conf.py b/doc/rtd/conf.py index 1e9539a9..a549a444 100644 --- a/doc/rtd/conf.py +++ b/doc/rtd/conf.py @@ -1,8 +1,6 @@ import os import sys -import sphinx_rtd_theme - from cloudinit import version # If extensions (or modules to document with autodoc) are in another directory, @@ -31,8 +29,7 @@ needs_sphinx = "4.0" # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ "m2r2", - "sphinx_rtd_theme", - "sphinx_panels", + "sphinx_design", "sphinx.ext.autodoc", "sphinx.ext.autosectionlabel", "sphinx.ext.viewcode", @@ -65,11 +62,15 @@ show_authors = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = "sphinx_rtd_theme" +html_theme = "furo" # The name of an image file (relative to this directory) to place at the top # of the sidebar. -html_logo = "static/logo.png" +html_static_path = ["static"] +html_theme_options = { + "light_logo": "logo.png", + "dark_logo": "logo-dark-mode.png", +} # Make sure the target is unique autosectionlabel_prefix_document = True diff --git a/doc/rtd/static/logo-dark-mode.png b/doc/rtd/static/logo-dark-mode.png Binary files differnew file mode 100644 index 00000000..90d63411 --- /dev/null +++ b/doc/rtd/static/logo-dark-mode.png diff --git a/doc/rtd/topics/modules.rst b/doc/rtd/topics/modules.rst index cbe0f5d7..b0ad83e4 100644 --- a/doc/rtd/topics/modules.rst +++ b/doc/rtd/topics/modules.rst @@ -3,7 +3,6 @@ Module Reference **************** -.. contents:: Table of Contents .. automodule:: cloudinit.config.cc_ansible .. automodule:: cloudinit.config.cc_apk_configure |
