Switch docs theme to Furo

kr8s-org · Dec 10, 2024 · 4747013 · 4747013
1 parent 6d5ee31
commit 4747013
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -44,7 +44,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+html_theme = "furo"
 html_theme_options = {
 }
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -40,6 +40,8 @@ docs = [
     "sphinx",
     "sphinx-click",
     "myst-parser>=3.0.1",
+    "furo>=2024.8.6",
+    "sphinx-autobuild>=2021.3.14",
 ]
 
 [build-system]

diff --git a/sphinx_helm/templates/markdown.jinja2 b/sphinx_helm/templates/markdown.jinja2
@@ -1,8 +1,7 @@
 {% extends "base.jinja2" %}
 
 {% block title -%}
-{{ name | capitalize }}
-===========
+## {{ name | capitalize }}
 {% endblock %}
 
 {% block description -%}
@@ -12,7 +11,7 @@
 {%- endblock %}
 
 {% block table -%}
-## Configuration
+### Configuration
 
 The following table lists the configurable parameters of the {{ name | capitalize }} chart and their default values.
 

diff --git a/sphinx_helm/templates/rst.jinja2 b/sphinx_helm/templates/rst.jinja2
@@ -7,7 +7,7 @@
 
 {% block title -%}
 {{ name | capitalize }}
-======================
+----------------------
 {% endblock -%}
 
 {% block description -%}
@@ -18,7 +18,7 @@
 
 {% block table -%}
 Configuration
--------------
+^^^^^^^^^^^^^
 
 The following table lists the configurable parameters of the {{ name | capitalize }} chart and their default values.
 

diff --git a/uv.lock b/uv.lock