Sphinx theme for ZEIT ONLINE docs
Project description
Usage
Install the package
$ pip install zondocs_theme
Then set html_theme = 'zondocs_theme' in your Sphinx conf.py.
Features
Automatically uses the ZON logo.
Adds an “edit this page” link to the sidebar. To customize how this link is created, you can set the following:
html_theme_options = { 'editme_link': ( 'https://github.com/zeitonline/{project}/edit/master/{page}') }
- (This is the default value, it supports two variables, project is taken
directly from conf.py, and page evaluates to path/to/current/page.suffix)
Local testing
Run bin/build to build whl and use pip install zondocs_theme...whl to use it in your project.
Release process
pipenv is needed to run the release process.
Update the version in pyproject.toml.
For a test release run
$ bin/release test
For a offical release run
$ bin/release prod
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zondocs_theme-1.0.8.tar.gz
(28.0 kB
view hashes)
Built Distribution
Close
Hashes for zondocs_theme-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17f83721e9d1da25fdd58ffdfb947d38290a66ea5bee083d90d822ef6da07788 |
|
MD5 | 7956805b937fafab63d25b717c1b6119 |
|
BLAKE2b-256 | 4a1e0fed588a1301c0b64f40b660c73d698eeb77f39d04623f1ca71d616740fb |