Skip to content
Sphinx theme for Python documentation
JavaScript CSS HTML Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
python_docs_theme Fix link to Sphinx (#34) Dec 10, 2019
.gitignore Initial commit Jun 4, 2017
LICENSE Initial version of theme. Jun 5, 2017
MANIFEST.in
README.rst Remind user about virtualenv and using python -m (#41) Jan 15, 2020
code_of_conduct.rst
setup.cfg Initial version of theme. Jun 5, 2017
setup.py post release version bump (#39) Jan 15, 2020

README.rst

Python Docs Sphinx Theme

This is the theme for the Python documentation.

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).

  1. Create and activate a virtual environment:

    $ python -m venv env
    $ source env/bin/activate
    
  2. Install python-docs-theme using pip:

    (env)$ python -m pip install python-docs-theme
    
You can’t perform that action at this time.