https://github.com/dask/dask-sphinx-theme
Sphinx theme for Dask documentation
https://github.com/dask/dask-sphinx-theme
hacktoberfest
Last synced: 10 months ago
JSON representation
Sphinx theme for Dask documentation
- Host: GitHub
- URL: https://github.com/dask/dask-sphinx-theme
- Owner: dask
- License: bsd-3-clause
- Created: 2018-09-06T14:51:50.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-14T20:10:41.000Z (over 1 year ago)
- Last Synced: 2025-07-30T14:27:30.032Z (11 months ago)
- Topics: hacktoberfest
- Language: Python
- Size: 168 KB
- Stars: 6
- Watchers: 3
- Forks: 15
- Open Issues: 18
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Dask Sphinx Theme
=================
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
.. code-block:: python
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:
.. code-block::
$ git checkout main
$ 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.