greschd / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community

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:

• PyMAPDL
• PyAEDT
• DPF-Core
• DPF-Post
• Legacy PyMAPDL Reader

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/ansys/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.