| Name | pydata-sphinx-theme JSON |
| Version |
0.15.2
JSON |
| download |
| home_page | |
| Summary | Bootstrap-based Sphinx theme from the PyData community |
| upload_time | 2024-01-18 23:23:33 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.9 |
| license | BSD 3-Clause License Copyright (c) 2018, pandas All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# The PyData Sphinx Theme
[](https://github.com/pydata/pydata-sphinx-theme/blob/main/LICENSE)
[](https://pypi.org/project/pydata-sphinx-theme/)
[](https://anaconda.org/conda-forge/pydata-sphinx-theme)
[](https://github.com/pydata/pydata-sphinx-theme/actions/workflows/tests.yml)
[](https://readthedocs.org/projects/pydata-sphinx-theme/builds/)
[](https://codecov.io/gh/pydata/pydata-sphinx-theme)
A clean, three-column, Bootstrap-based Sphinx theme by and for the [PyData community](https://pydata.org).
- :books: Documentation: https://pydata-sphinx-theme.readthedocs.io/en/stable
- :bulb: Examples: https://pydata-sphinx-theme.readthedocs.io/en/stable/examples
- :raised_hands: Contribute: https://pydata-sphinx-theme.readthedocs.io/en/stable/community
[](https://pydata-sphinx-theme.readthedocs.io/en/stable)
## Installation and usage
The theme is available on PyPI and conda-forge. You can install
and use as follows:
- Install the `pydata-sphinx-theme` in your doc build environment:
```bash
pip install pydata-sphinx-theme
# or
conda install pydata-sphinx-theme --channel conda-forge
```
- Then, in the `conf.py` of your sphinx docs, you update the `html_theme`
configuration option:
```python
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](https://pydata-sphinx-theme.readthedocs.io/en/stable/community/practices/versions.html#supported-sphinx-versions) 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:
- [Community and contributing documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/community/index.html)
Raw data
{
"_id": null,
"home_page": "",
"name": "pydata-sphinx-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Joris Van den Bossche <jorisvandenbossche@gmail.com>",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b8/46/69150af28bfce3dc7594c0b6b1f12143eff685b96a18747a821fd255c432/pydata_sphinx_theme-0.15.2.tar.gz",
"platform": null,
"description": "# The PyData Sphinx Theme\n\n[](https://github.com/pydata/pydata-sphinx-theme/blob/main/LICENSE)\n[](https://pypi.org/project/pydata-sphinx-theme/)\n[](https://anaconda.org/conda-forge/pydata-sphinx-theme)\n[](https://github.com/pydata/pydata-sphinx-theme/actions/workflows/tests.yml)\n[](https://readthedocs.org/projects/pydata-sphinx-theme/builds/)\n[](https://codecov.io/gh/pydata/pydata-sphinx-theme)\n\nA clean, three-column, Bootstrap-based Sphinx theme by and for the [PyData community](https://pydata.org).\n\n- :books: Documentation: https://pydata-sphinx-theme.readthedocs.io/en/stable\n- :bulb: Examples: https://pydata-sphinx-theme.readthedocs.io/en/stable/examples\n- :raised_hands: Contribute: https://pydata-sphinx-theme.readthedocs.io/en/stable/community\n\n[](https://pydata-sphinx-theme.readthedocs.io/en/stable)\n\n## Installation and usage\n\nThe theme is available on PyPI and conda-forge. You can install\nand use as follows:\n\n- Install the `pydata-sphinx-theme` in your doc build environment:\n\n ```bash\n pip install pydata-sphinx-theme\n # or\n conda install pydata-sphinx-theme --channel conda-forge\n ```\n\n- Then, in the `conf.py` of your sphinx docs, you update the `html_theme`\n configuration option:\n\n ```python\n html_theme = \"pydata_sphinx_theme\"\n ```\n\nAnd that's it!\n\n> **Note**\n> This theme may not work with the latest major versions of Sphinx, especially\n> if they have only recently been released. Please give us a few months of\n> time to work out any bugs and changes when new releases are made.\n> See [our contributing documentation](https://pydata-sphinx-theme.readthedocs.io/en/stable/community/practices/versions.html#supported-sphinx-versions) for more information.\n\n## Contribute to and develop the theme\n\nContributions are very welcome! Installing the development version, building\nthe example docs and developing the `CSS/JS` of the theme, etc., is explained in\nmore detail in the contributing section of the documentation:\n\n- [Community and contributing documentation](https://pydata-sphinx-theme.readthedocs.io/en/latest/community/index.html)\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2018, pandas All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "Bootstrap-based Sphinx theme from the PyData community",
"version": "0.15.2",
"project_urls": {
"Source": "https://github.com/pydata/pydata-sphinx-theme"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcef1700096a5c1d17c2d99332b0759c7ca70346aac917ceafa4c380f085d359",
"md5": "e0df8d61d96b717b2536c44aac53fb44",
"sha256": "0c5fa1fa98a9b26dae590666ff576f27e26c7ba708fee754ecb9e07359ed4588"
},
"downloads": -1,
"filename": "pydata_sphinx_theme-0.15.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0df8d61d96b717b2536c44aac53fb44",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4523706,
"upload_time": "2024-01-18T23:23:31",
"upload_time_iso_8601": "2024-01-18T23:23:31.417643Z",
"url": "https://files.pythonhosted.org/packages/bc/ef/1700096a5c1d17c2d99332b0759c7ca70346aac917ceafa4c380f085d359/pydata_sphinx_theme-0.15.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b84669150af28bfce3dc7594c0b6b1f12143eff685b96a18747a821fd255c432",
"md5": "3c602d1d99931b3d3efe0cc951b526d2",
"sha256": "4243fee85b3afcfae9df64f83210a04e7182e53bc3db8841ffff6d21d95ae320"
},
"downloads": -1,
"filename": "pydata_sphinx_theme-0.15.2.tar.gz",
"has_sig": false,
"md5_digest": "3c602d1d99931b3d3efe0cc951b526d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 2416053,
"upload_time": "2024-01-18T23:23:33",
"upload_time_iso_8601": "2024-01-18T23:23:33.467720Z",
"url": "https://files.pythonhosted.org/packages/b8/46/69150af28bfce3dc7594c0b6b1f12143eff685b96a18747a821fd255c432/pydata_sphinx_theme-0.15.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 23:23:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pydata",
"github_project": "pydata-sphinx-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pydata-sphinx-theme"
}
