1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
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 <https://github.com/dask/dask-sphinx-theme/blob/main/.github/workflows/publish-pypi.yml>`_
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 <https://github.com/conda-forge/dask-sphinx-theme-feedstock>`_
for the new ``x.y.z`` release will automatically be opened by conda-forge bots.
|
