This is the ansys-sphinx-theme module.
Project description
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.
Project details
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
Hashes for ansys-sphinx-theme-0.4.dev0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0bfdd9cec0b08e408f84a655836e4c67005081ed997276940e7025d16116966 |
|
MD5 | c95b13fdc12c4ff27d56101bfdc5c524 |
|
BLAKE2b-256 | bda74d89ee8b740796fb1a929fdf76e7c830faaafdbf511e70907407372adab4 |