summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..2791ea7
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,29 @@
+Pallets Sphinx Themes
+=====================
+
+Themes for the Pallets projects. If you're writing an extension, use the
+appropriate theme to make your documentation look consistent.
+
+Available themes:
+
+- flask
+- jinja
+- werkzeug
+- click
+
+Install this package:
+
+.. code-block:: text
+
+ pip install Pallets-Sphinx-Themes
+
+Enable the extension and choose the theme in ``docs/conf.py``:
+
+.. code-block:: python
+
+ extensions = [
+ "pallets_sphinx_themes",
+ ...
+ ]
+
+ html_theme = "flask"