https://github.com/flightaware/tohil-docs-theme
Tohil Docs Sphinx Theme
https://github.com/flightaware/tohil-docs-theme
Last synced: about 1 month ago
JSON representation
Tohil Docs Sphinx Theme
- Host: GitHub
- URL: https://github.com/flightaware/tohil-docs-theme
- Owner: flightaware
- License: other
- Created: 2021-05-09T18:33:58.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-06T15:56:23.000Z (almost 5 years ago)
- Last Synced: 2023-04-18T10:34:10.165Z (about 3 years ago)
- Language: JavaScript
- Size: 66.4 KB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
Tohil Docs Sphinx Theme
=========================
This is the theme for the Tohil documentation, heavily heavily based on
the theme for the Python documentation at https://github.com/python/python-docs-theme.
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 = 'tohil_docs_theme'``
- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
But really you probably want to start with this or the Python theme or whatever, and
change the theme.conf, etc.