GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - skpanagiotis/python-docs-theme: Sphinx theme for Python documentation

BranchesTags
Open more actions menu
 
 

Latest commit

 

History

313 Commits
313 Commits

Folders and files

NameName
Last commit message
Last commit date
.github
.github
 
 
python_docs_theme
python_docs_theme
 
 
.babel.cfg
.babel.cfg
 
 
.gitignore
.gitignore
 
 
.pre-commit-config.yaml
.pre-commit-config.yaml
 
 
.readthedocs.yml
.readthedocs.yml
 
 
CHANGELOG.rst
CHANGELOG.rst
 
 
CONTRIBUTING.rst
CONTRIBUTING.rst
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
babel_runner.py
babel_runner.py
 
 
pyproject.toml
pyproject.toml
 
 
requirements.txt
requirements.txt
 
 

Repository files navigation

Python Docs Sphinx Theme

This is the theme for the Python documentation. It requires Python 3.12 or newer and Sphinx 7.3 or newer.

Note that when adopting this theme, you're also borrowing an element of the trust and credibility established by the CPython core developers over the years. That's fine, and you're welcome to do so for other Python community 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 (preferably in a virtual environment).

Configuration options

To use this theme, add the following to conf.py:

  • html_theme = 'python_docs_theme'

  • html_sidebars, defaults taken from https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars

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/

About

Sphinx theme for Python documentation

Resources

Readme
License

Contributing

Contributing
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.