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 --tags
After 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.
Project details
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-2.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 674a9b5bfbbafa9e7c3d250494d3e9da4b0098b69f627f2c8edb629344c95be0 |
|
MD5 | 0ce5e26c65fbf0ad06a366737ca23497 |
|
BLAKE2b-256 | df2077d9532a2f6553eb8461172f0c057b16ce24c77ed889e41f9709d3a0f306 |