Metadata-Version: 2.1
Name: ansys-sphinx-theme
Version: 1.5.0
Summary: A theme devised by ANSYS, Inc. for Sphinx documentation.
Author-Email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-Email: "ANSYS, Inc." <pyansys.core@ansys.com>
License: MIT License
         
         Copyright (c) 2021 - 2025 ANSYS, Inc. and/or its affiliates.
         
         Permission is hereby granted, free of charge, to any person obtaining a copy of
         this software and associated documentation files (the "Software"), to deal in
         the Software without restriction, including without limitation the rights to
         use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
         of the Software, and to permit persons to whom the Software is furnished to do
         so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Project-URL: Home, https://sphinxdocs.ansys.com/
Project-URL: Source, https://github.com/ansys/ansys-sphinx-theme
Project-URL: Tracker, https://github.com/ansys/ansys-sphinx-theme/issues
Project-URL: Documentation, https://sphinxdocs.ansys.com/
Requires-Python: <4,>=3.10
Requires-Dist: Sphinx>=6.1.0
Requires-Dist: pydata-sphinx-theme<0.17,>=0.15.4
Requires-Dist: Jinja2>=3.1.2
Requires-Dist: importlib-metadata>=4.0
Requires-Dist: pdf2image>=1.17.0
Provides-Extra: autoapi
Requires-Dist: sphinx-autoapi==3.6.0; extra == "autoapi"
Requires-Dist: sphinx-design==0.6.1; extra == "autoapi"
Requires-Dist: sphinx-jinja==2.0.2; extra == "autoapi"
Requires-Dist: astroid<4.0,>=3.0; extra == "autoapi"
Provides-Extra: doc
Requires-Dist: jupytext==1.17.1; extra == "doc"
Requires-Dist: notebook==7.4.3; extra == "doc"
Requires-Dist: nbsphinx==0.9.7; extra == "doc"
Requires-Dist: numpydoc==1.8.0; extra == "doc"
Requires-Dist: pandas==2.2.3; extra == "doc"
Requires-Dist: Pillow>=9.0; extra == "doc"
Requires-Dist: plotly==6.1.2; extra == "doc"
Requires-Dist: PyGitHub==2.6.1; extra == "doc"
Requires-Dist: pyvista[jupyter]==0.45.2; extra == "doc"
Requires-Dist: PyYAML==6.0.2; extra == "doc"
Requires-Dist: requests==2.32.3; extra == "doc"
Requires-Dist: sphinx-autoapi==3.6.0; extra == "doc"
Requires-Dist: sphinx-copybutton==0.5.2; extra == "doc"
Requires-Dist: sphinx-design==0.6.1; extra == "doc"
Requires-Dist: sphinx-gallery==0.19.0; extra == "doc"
Requires-Dist: sphinx-jinja==2.0.2; extra == "doc"
Requires-Dist: sphinx-notfound-page==1.1.0; extra == "doc"
Requires-Dist: tox==4.26.0; extra == "doc"
Requires-Dist: sphinx-theme-builder[cli]==0.2.0b2; extra == "doc"
Provides-Extra: changelog
Requires-Dist: PyYAML==6.0.2; extra == "changelog"
Requires-Dist: sphinx-design==0.6.1; extra == "changelog"
Description-Content-Type: text/x-rst

Ansys Sphinx theme
==================
|ansys| |python| |pypi| |GH-CI| |MIT| |black|

.. |ansys| image:: https://img.shields.io/badge/Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
   :target: https://github.com/ansys
   :alt: Ansys

.. |python| image:: https://img.shields.io/pypi/pyversions/ansys_sphinx_theme?logo=pypi
   :target: https://pypi.org/project/ansys-sphinx-theme/
   :alt: Python

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-sphinx-theme.svg?logo=python&logoColor=white
   :target: https://pypi.org/project/ansys-sphinx-theme
   :alt: PyPI

.. |GH-CI| image:: https://github.com/ansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml/badge.svg
   :target: https://github.com/ansys/ansys-sphinx-theme/actions/workflows/ci_cd.yml
   :alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
   :target: https://opensource.org/licenses/MIT
   :alt: MIT

.. |black| image:: https://img.shields.io/badge/code_style-black-000000.svg?style=flat
   :target: https://github.com/psf/black
   :alt: Black

.. |Downloads| image:: https://img.shields.io/pypi/dm/ansys-sphinx-theme.svg?label=PyPI%20downloads
   :target: https://pypi.org/project/ansys-sphinx-theme
   :alt: Downloads


Introduction
------------
The Ansys Sphinx theme is an extension of the popular
`PyData Sphinx theme <https://github.com/pydata/pydata-sphinx-theme>`_
that is used by `numpy <https://numpy.org/doc/stable/>`_,
`pandas <https://pandas.pydata.org/docs/>`_,
`pyvista <https://docs.pyvista.org>`_, and many more
scientific Python packages.

You use the Ansys Sphinx theme with `Sphinx <https://www.sphinx-doc.org/en/master/>`_,
a Python documentation generator, to create documentation.
The theme's objective is to ensure that Ansys documentation
looks and behaves consistently.

While this theme is primarily used to create documentation
for PyAnsys libraries, you can also use it to create
documentation for any Ansys project with content in
reStructuredText (RST) and Markdown (files).

If you are new to using Sphinx, see `Sphinx Getting Started
<https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_.

Documentation and issues
~~~~~~~~~~~~~~~~~~~~~~~~
Documentation for the latest stabe release of Ansys Sphinx theme is hosted at
`Ansys Sphinx Theme documentation <https://sphinxdocs.ansys.com>`_.

The documentation has these sections:

- `Getting started <https://sphinxdocs.ansys.com/version/stable/getting_started.html>`_ : Learn
  how to install the theme and use it in your Sphinx project.
- `User guide <https://sphinxdocs.ansys.com/version/stable/user_guide.html>`_ : Learn how to
  customize the theme and use its features.
- `Examples <https://sphinxdocs.ansys.com/version/stable/examples.html>`_ : See examples of
  Sphinx components and how it renders with the Ansys Sphinx theme.
- `Release notes <https://sphinxdocs.ansys.com/version/stable/changelog.html>`_ : See the
  changes in each release of the theme.

On the `Issues page <https://github.com/ansys/ansys-sphinx-theme/issues>`_
for this repository, you can create issues to submit questions, report bugs,
and request new features. To reach the PyAnsys support team, email
`pyansys.core@ansys.com <pyansys.core@ansys.com>`_.

License
~~~~~~~
This theme is licensed under the `MIT License
<https://raw.githubusercontent.com/ansys/ansys-sphinx-theme/main/LICENSE>`_.
