Dask theme for Sphinx
Project description
This is the official Sphinx theme for Dask documentation. It extends the sphinx-book-theme project, but adds custom styling and a navigation bar to additional Dask subprojects.
When creating a Dask subproject you can include this theme by changing this line in your conf.py file
html_theme = 'dask_sphinx_theme'And by including dask_sphinx_theme as a requirement in your documentation installation.
Releasing
This project uses GitHub Actions to automatically push a new release to PyPI whenever a git tag is pushed. For example, to release a new x.y.z version of dask-sphinx-theme, checkout the commit you would like to release, add a git tag, and push the tag to the main branch of the dask/dask-sphinx-theme repository:
Bump the __version__ in dask_sphinx_theme/__init__.py.
$ git checkout <commit-hash>
$ git tag -a x.y.z -m 'Version x.y.z'
$ git push upstream main --tagsAfter a new release is published on PyPI, a pull request to the dask-sphinx-theme conda-forge feedstock for the new x.y.z release will automatically be opened by conda-forge bots.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dask_sphinx_theme-3.0.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4bfc9ead3bdc616428f2c24eeb33d4ac3c4d41c82de3fa533da819ce6c458418 |
|
| MD5 | 85480cd10bb4d40973ff811b498438fd |
|
| BLAKE2b-256 | 02818fa75f4f1b81d885a145cf309f340bd9584b57535075ce6b3ad11d3e46b8 |
