| 1 |
Metadata-Version: 2.4 |
| 2 |
Name: dask_sphinx_theme |
| 3 |
Version: 4.0.0 |
| 4 |
Summary: Dask theme for Sphinx |
| 5 |
Project-URL: Homepage, https://github.com/dask/dask-sphinx-theme/ |
| 6 |
Author: Dask Developers |
| 7 |
License: BSD |
| 8 |
License-File: LICENSE.txt |
| 9 |
Requires-Python: >=3.11 |
| 10 |
Requires-Dist: jsonschema |
| 11 |
Requires-Dist: numpydoc |
| 12 |
Requires-Dist: pyyaml |
| 13 |
Requires-Dist: sphinx-book-theme<2,>=1 |
| 14 |
Requires-Dist: sphinx>=7.0 |
| 15 |
Description-Content-Type: text/x-rst |
| 16 |
|
| 17 |
Dask Sphinx Theme |
| 18 |
================= |
| 19 |
|
| 20 |
This is the official Sphinx theme for Dask documentation. It extends the |
| 21 |
``sphinx-book-theme`` project, but adds custom styling and a navigation bar to |
| 22 |
additional Dask subprojects. |
| 23 |
|
| 24 |
When creating a Dask subproject you can include this theme by changing this |
| 25 |
line in your conf.py file |
| 26 |
|
| 27 |
.. code-block:: python |
| 28 |
|
| 29 |
html_theme = 'dask_sphinx_theme' |
| 30 |
|
| 31 |
And by including ``dask_sphinx_theme`` as a requirement in your documentation |
| 32 |
installation. |
| 33 |
|
| 34 |
Releasing |
| 35 |
--------- |
| 36 |
|
| 37 |
This project `uses GitHub Actions <https://github.com/dask/dask-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_ |
| 38 |
to automatically push a new release to PyPI whenever |
| 39 |
a git tag is pushed. For example, to release a new ``x.y.z`` version of |
| 40 |
``dask-sphinx-theme``, checkout the commit you would like to release, |
| 41 |
add a git tag, and push the tag to the ``main`` branch of the |
| 42 |
``dask/dask-sphinx-theme`` repository: |
| 43 |
|
| 44 |
.. code-block:: |
| 45 |
|
| 46 |
$ git checkout main |
| 47 |
$ git tag -a x.y.z -m 'Version x.y.z' |
| 48 |
$ git push upstream main --tags |
| 49 |
|
| 50 |
After a new release is published on PyPI, a pull request to the ``dask-sphinx-theme`` |
| 51 |
`conda-forge feedstock <https://github.com/conda-forge/dask-sphinx-theme-feedstock>`_ |
| 52 |
for the new ``x.y.z`` release will automatically be opened by conda-forge bots. |