Ansys Sphinx Theme
Introduction and Purpose
The Ansys Sphinx theme is an extension of the popular PyData Sphinx Theme used by numpy, pandas, PyVista and a variety other packages. This theme was packaged so that all PyAnsys packages would look and behave consistently.
Documentation
Full documentation can be found at Ansys Sphinx Theme Documentation. The webpage was also built using the ansys-sphinx-theme, so visit the site for a preview of the theme.
Other PyAnsys packages using the Ansys theme include:
Getting Started
Install this theme with:
pip install ansys-sphinx-theme
Next, modify your sphinx conf.py to use html_theme = 'ansys_sphinx_theme'. If you are new to using Sphinx, see Sphinx Getting Started documentation.
For usage information, see Using this Theme
Development and Contributing
Feel free to add features or post issues. To develop this theme:
git clone https://github.com/pyansys/ansys-sphinx-theme.git pip install -U pip tox tox -e style,doc
We use pre-commit to simplify style checks. You can optionally use this by following the installation and usage guides.
License
This theme is licensed under the MIT License.
Metadata
Release files for ansys-sphinx-theme 0.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ansys-sphinx-theme-0.4.0.tar.gz | 755.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ansys_sphinx_theme-0.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.5 MB
Release files / ansys-sphinx-theme-0.4.0.tar.gz
| Download URL | ansys-sphinx-theme-0.4.0.tar.gz |
|---|---|
| Size | 755.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
31f7b840ce0269d33e5cfdc3eeddeee349abe822748aeac689a79434ce6d6126
|
|
BLAKE2b-256 checksum How to use checksums |
8fc56a1776a946a4f1c33e856e11de7f154d5da54206ab8a1c2b5a6ffb39a365
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|
Release files / ansys_sphinx_theme-0.4.0-py3-none-any.whl
| Download URL | ansys_sphinx_theme-0.4.0-py3-none-any.whl |
|---|---|
| Size | 758.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f09fe7f8aeab006ddc22914e637e95ee83f9481134b8ee5d330b364189910f42
|
|
BLAKE2b-256 checksum How to use checksums |
5dc1ba52bb26d634253881732cfa508a16039a5105a01bf6a1808f5a068154eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.0 CPython/3.9.12
|