https://github.com/ansys/ansys-sphinx-theme

Ansys corporate theme for Sphinx pages
https://github.com/ansys/ansys-sphinx-theme

ansys hacktoberfest python sphinx sphinx-doc sphinx-theme

Last synced: 4 months ago
JSON representation

Ansys corporate theme for Sphinx pages

• Host: GitHub
• URL: https://github.com/ansys/ansys-sphinx-theme
• Owner: ansys
• License: mit
• Created: 2021-05-24T16:14:20.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2026-01-27T11:57:09.000Z (4 months ago)
• Last Synced: 2026-01-27T13:14:05.214Z (4 months ago)
• Topics: ansys, hacktoberfest, python, sphinx, sphinx-doc, sphinx-theme
• Language: Python
• Homepage: https://sphinxdocs.ansys.com/
• Size: 74.5 MB
• Stars: 30
• Watchers: 50
• Forks: 8
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

          
Ansys Sphinx theme

==================

|ansys| |python| |pypi| |GH-CI| |MIT| |Ruff|

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

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

.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json

   :target: https://github.com/astral-sh/ruff

   :alt: Ruff

Introduction

------------

The Ansys Sphinx theme is an extension of the popular

`PyData Sphinx theme `_

that is used by `numpy `_,

`pandas `_,

`pyvista `_, and many more

scientific Python packages.

You use the Ansys Sphinx theme with `Sphinx `_,

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

`_.

Documentation and issues

~~~~~~~~~~~~~~~~~~~~~~~~

Documentation for the latest stabe release of Ansys Sphinx theme is hosted at

`Ansys Sphinx Theme documentation `_.

The documentation has these sections:

- `Getting started `_ : Learn

  how to install the theme and use it in your Sphinx project.

- `User guide `_ : Learn how to

  customize the theme and use its features.

- `Examples `_ : See examples of

  Sphinx components and how it renders with the Ansys Sphinx theme.

- `Release notes `_ : See the

  changes in each release of the theme.

On the `Issues page `_

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 `_.

License

~~~~~~~

This theme is licensed under the `MIT License

`_.