Skip to main content

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:

$ 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dask_sphinx_theme-2.0.2.tar.gz (26.1 kB view details)

Uploaded Source

Built Distribution

dask_sphinx_theme-2.0.2-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file dask_sphinx_theme-2.0.2.tar.gz.

File metadata

  • Download URL: dask_sphinx_theme-2.0.2.tar.gz
  • Upload date:
  • Size: 26.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for dask_sphinx_theme-2.0.2.tar.gz
Algorithm Hash digest
SHA256 8186365c0037903b0518647f4312ffa8d5e3c37d110c82da6a49980f17df2019
MD5 8b6b541e149738cb38aaa98a307369e8
BLAKE2b-256 0ade742d451d67a364d0c27e0df4a1edb31213d9ae534a316cfcd1425206f713

See more details on using hashes here.

Provenance

File details

Details for the file dask_sphinx_theme-2.0.2-py3-none-any.whl.

File metadata

  • Download URL: dask_sphinx_theme-2.0.2-py3-none-any.whl
  • Upload date:
  • Size: 25.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for dask_sphinx_theme-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 263617536c0c0aedd9b46fdd635b8a757bde3ba48dfd5527897267cd4ffe42b8
MD5 caf0092472edffe5e4091250bdce2537
BLAKE2b-256 1ccce4dc0ce8184ab44105a0b74e38209e5d0c65476afff4e9137cc9b191a727

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page