Change documentation theme

Change the theme to material theme
openstack-k8s-operators · Oct 5, 2023 · c2ffef7 · c2ffef7
1 parent 06a9aa1
commit c2ffef7
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 99 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,7 +1,7 @@
 ansible-core>=2.14.6
 sphinx>=6.2.1 # BSD
 sphinx-autobuild>=2021.3.1
-sphinx_rtd_theme>=1.2.2
+sphinx-material
 doc8>=0.8.1 # Apache-2.0
 sphinxemoji
 myst-parser
diff --git a/docs/source/Makefile b/docs/source/Makefile
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -83,14 +83,27 @@
 
 # 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_logo = "images/logo_cifmw_200.png"
+html_theme = "sphinx_material"
 
 # 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
 # documentation.
 #
-# html_theme_options = {}
+html_theme_options = {
+    "base_url": "https://github.com/openstack-k8s-operators/test-operator/",
+    "repo_url": "https://github.com/openstack-k8s-operators/test-operator/",
+    "nav_title": "test-operator",
+    "repo_name": "test-operator",
+    "repo_type": "github",
+    "globaltoc_depth": 2,
+    "color_primary": "blue-grey",
+    "color_accent": "cyan",
+    "touch_icon": "images/openstack-logo.png",
+    "theme_color": "#2196f3",
+    "master_doc": False,
+    "table_classes": ["plain"],
+}
 
 # -- Options for HTMLHelp output ------------------------------------------