From 7d6728357b1a80b616f65054ad105eb7e2bd9048 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 26 Mar 2024 15:07:01 +0200 Subject: [PATCH 1/2] Link to kitchen sink demo in README --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index 5055bad1..3d78430c 100644 --- a/README.rst +++ b/README.rst @@ -29,3 +29,7 @@ Preview See a demo of the CPython docs using this theme: - https://python-docs-theme-previews.readthedocs.io + +The kitchen sink is a showcase of every Sphinx feature: + +- https://sphinx-themes.org/sample-sites/python-docs-theme/kitchen-sink/ From 6e87b15170662ecf21ee2955cc916f2c3785489d Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Tue, 26 Mar 2024 15:09:26 +0200 Subject: [PATCH 2/2] Convert README to Markdown --- README.rst => README.md | 17 +++++++---------- pyproject.toml | 2 +- 2 files changed, 8 insertions(+), 11 deletions(-) rename README.rst => README.md (69%) diff --git a/README.rst b/README.md similarity index 69% rename from README.rst rename to README.md index 3d78430c..f77b4910 100644 --- a/README.rst +++ b/README.md @@ -1,5 +1,4 @@ -Python Docs Sphinx Theme -========================= +# Python Docs Sphinx Theme This is the theme for the Python documentation. @@ -10,21 +9,19 @@ projects if you so choose, but please keep in mind that in doing so you're also choosing to accept some of the responsibility for maintaining that collective trust. -To use the theme, install it into your docs build environment via ``pip`` +To use the theme, install it into your docs build environment via `pip` (preferably in a virtual environment). -Configuration options ---------------------- +## Configuration options -To use this theme, add the following to ``conf.py``: +To use this theme, add the following to `conf.py`: -- ``html_theme = 'python_docs_theme'`` +- `html_theme = 'python_docs_theme'` -- ``html_sidebars``, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars +- `html_sidebars`, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars -Preview -------- +## Preview See a demo of the CPython docs using this theme: diff --git a/pyproject.toml b/pyproject.toml index fc5f5513..c376bbd3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ requires = [ name = "python-docs-theme" version = "2024.3" description = "The Sphinx theme for the CPython docs and related projects" -readme = "README.rst" +readme = "README.md" license.file = "LICENSE" authors = [{name = "PyPA", email = "distutils-sig@python.org"}] requires-python = ">=3.8" pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy