Commit 6e87b15
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,5 +1,4 @@ | |||
| 1 | - Python Docs Sphinx Theme | ||
| 2 | - ========================= | ||
| 1 | + # Python Docs Sphinx Theme | ||
| 3 | 2 | ||
| 4 | 3 | This is the theme for the Python documentation. | |
| 5 | 4 | ||
@@ -10,21 +9,19 @@ projects if you so choose, but please keep in mind that in doing so you're also | |||
| 10 | 9 | choosing to accept some of the responsibility for maintaining that collective | |
| 11 | 10 | trust. | |
| 12 | 11 | ||
| 13 | - To use the theme, install it into your docs build environment via ``pip`` | ||
| 12 | + To use the theme, install it into your docs build environment via `pip` | ||
| 14 | 13 | (preferably in a virtual environment). | |
| 15 | 14 | ||
| 16 | 15 | ||
| 17 | - Configuration options | ||
| 18 | - --------------------- | ||
| 16 | + ## Configuration options | ||
| 19 | 17 | ||
| 20 | - To use this theme, add the following to ``conf.py``: | ||
| 18 | + To use this theme, add the following to `conf.py`: | ||
| 21 | 19 | ||
| 22 | - - ``html_theme = 'python_docs_theme'`` | ||
| 20 | + - `html_theme = 'python_docs_theme'` | ||
| 23 | 21 | ||
| 24 | - - ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars | ||
| 22 | + - `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars | ||
| 25 | 23 | ||
| 26 | - Preview | ||
| 27 | - ------- | ||
| 24 | + ## Preview | ||
| 28 | 25 | ||
| 29 | 26 | See a demo of the CPython docs using this theme: | |
| 30 | 27 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -8,7 +8,7 @@ requires = [ | |||
| 8 | 8 | name = "python-docs-theme" | |
| 9 | 9 | version = "2024.3" | |
| 10 | 10 | description = "The Sphinx theme for the CPython docs and related projects" | |
| 11 | - readme = "README.rst" | ||
| 11 | + readme = "README.md" | ||
| 12 | 12 | license.file = "LICENSE" | |
| 13 | 13 | authors = [{name = "PyPA", email = "distutils-sig@python.org"}] | |
| 14 | 14 | requires-python = ">=3.8" | |
0 commit comments