Skip to content

Link to kitchen sink demo in README and convert to Markdown#184

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.

Sign up for GitHub

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

Merged
hugovk merged 2 commits into from
Mar 31, 2024
Merged

Link to kitchen sink demo in README and convert to Markdown #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d67283
Link to kitchen sink demo in README
hugovk Mar 26, 2024
6e87b15
Convert README to Markdown
hugovk Mar 26, 2024
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
21 changes: 11 additions & 10 deletions README.rst → README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
Python Docs Sphinx Theme
=========================
# Python Docs Sphinx Theme

This is the theme for the Python documentation.

Expand All@@ -10,22 +9,24 @@ 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:

- 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/
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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 = "[email protected]"}]
requires-python = ">=3.8"
Expand Down