Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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.

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

Already on GitHub?Sign in to your account

Merged
hugovk merged 2 commits intopython:mainfromhugovk:readme-kitchen-sink
Mar 31, 2024
Merged
Show file tree
Hide file tree
Changes fromall 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
21 changes: 11 additions & 10 deletionsREADME.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 deletionpyproject.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 = "distutils-sig@python.org"}]
requires-python = ">=3.8"
Expand Down
[8]ページ先頭
©2009-2025 Movatter.jp