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)
Release process
pipenv is needed to run the release process.
To release the package run
$ bin/release
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.7.tar.gz
(27.6 kB
view hashes)
Built Distribution
Close
Hashes for zondocs_theme-1.0.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 738447f2979f8523d1e5a4d37e00914c69432a95742ec78356313a315e392a1b |
|
MD5 | 8924adcc702298d4a64976121df5504e |
|
BLAKE2b-256 | d3680d690df58ba06b92885b101d06a2e08825d2f2861babeb00749c2b93b75c |