Bootstrap-based Sphinx theme from the PyData community
Project description
The PyData Sphinx Theme
A clean, three-column, Bootstrap-based Sphinx theme by and for the PyData community.
- 📚 Documentation: https://pydata-sphinx-theme.readthedocs.io/en/latest/
- 💡 Examples: https://pydata-sphinx-theme.readthedocs.io/en/latest/examples/
- 🙌 Contribute: https://pydata-sphinx-theme.readthedocs.io/en/latest/community/index.html
Installation and usage
The theme is available on PyPI and conda-forge. You can install and use as follows:
-
Install the
pydata-sphinx-themein your doc build environment:pip install pydata-sphinx-theme # or conda install pydata-sphinx-theme --channel conda-forge -
Then, in the
conf.pyof your sphinx docs, you update thehtml_themeconfiguration option:html_theme = "pydata_sphinx_theme"
And that's it!
Note This theme may not work with the latest major versions of Sphinx, especially if they have only recently been released. Please give us a few months of time to work out any bugs and changes when new releases are made. See our contributing documentation for more information.
Contribute to and develop the theme
Contributions are very welcome! Installing the development version, building the example docs and developing the css/js of the theme, etc, is explained in more detail in the contributing section of the documentation:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pydata_sphinx_theme-0.11.0rc2.tar.gz.
File metadata
- Download URL: pydata_sphinx_theme-0.11.0rc2.tar.gz
- Upload date:
- Size: 3.4 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7820767ff67fa8d898914927990c489e3f24ceab06f7cb3b339a43e1ca1273f1 |
|
| MD5 | afaed84f3dc3e0004a25c9c250d7c95e |
|
| BLAKE2b-256 | ec544612d043bb0236ae7e08612a0e1f446fd3ac89fbb2b4cbb72fdf137492d8 |
Provenance
File details
Details for the file pydata_sphinx_theme-0.11.0rc2-py3-none-any.whl.
File metadata
- Download URL: pydata_sphinx_theme-0.11.0rc2-py3-none-any.whl
- Upload date:
- Size: 1.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8b54c7f4fab5d1df97e81083618388358cebf19077f82a7253d935cc0302224c |
|
| MD5 | 435f6f23e45e19a894b00347db4dfc6c |
|
| BLAKE2b-256 | 8dcfbb5e810e4ec80e50bfc9e09fdc6823e59ad6f19b15b86908f92844a78f28 |
