console
Sphinx Theme collections.
When you find new theme on PyPI, please file an issue. Currently, themes are updated by hands only.
Requirements:
docker
parcel
(sudo npm install -g parcel-bundler
)
- Fork the sphinx-themes.org repository
Clone your fork:
$ git clone https://github.com/<your-username>/sphinx-themes.org
Create a new branch for your new theme:
$ git checkout -b "Add <pypi-pkg-name-of-theme>"
Build the docker container (this may take a long time):
$ make build
Generate assets for your new theme:
$ PKG_NAME=<pypi-pkg-name-of-theme> THEME=<sphinx-theme-name> make build run
Note:
<pypi-pkg-name-of-theme>
and<sphinx-theme-name>
are sometimes different. Make sure to read the theme's documentation.<pypi-pkg-name-of-theme>
is the name you use to install the package (pip install <pypi-pkg-name-of-theme>
)<sphinx-theme-name>
is the name you use in your sphinxconf.py
(html_theme = '<sphinx-theme-name>'
)
If something fails, check and edit the generated
src/<pypi-pkg-name-of-theme>/<sphinx-theme-name>/conf.py
manually and retry.- Add an entry with the
<pypi-pkg-name-of-theme>
tolog.csv
Commit and push your changes:
$ git add html src log.csv $ git commit -m "Add <pypi-pkg-name-of-theme>" $ git push
- Make a Pull Request on GitHub
BSD License (same as Sphinx
)