Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch docs theme to Furo #8

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
}

Expand Down
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ docs = [
"sphinx",
"sphinx-click",
"myst-parser>=3.0.1",
"furo>=2024.8.6",
"sphinx-autobuild>=2021.3.14",
]

[build-system]
Expand Down
5 changes: 2 additions & 3 deletions sphinx_helm/templates/markdown.jinja2
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
{% extends "base.jinja2" %}

{% block title -%}
{{ name | capitalize }}
===========
## {{ name | capitalize }}
{% endblock %}

{% block description -%}
Expand All @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions sphinx_helm/templates/rst.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

{% block title -%}
{{ name | capitalize }}
======================
----------------------
{% endblock -%}

{% block description -%}
Expand All @@ -18,7 +18,7 @@

{% block table -%}
Configuration
-------------
^^^^^^^^^^^^^

The following table lists the configurable parameters of the {{ name | capitalize }} chart and their default values.

Expand Down
102 changes: 99 additions & 3 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading