Skip to main content

A theme devised by ANSYS, Inc. for Sphinx documentation.

Project description

Ansys Python PyPI GH-CI MIT 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.

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

ansys_sphinx_theme-1.7.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ansys_sphinx_theme-1.7.0-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

Details for the file ansys_sphinx_theme-1.7.0.tar.gz.

File metadata

  • Download URL: ansys_sphinx_theme-1.7.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ansys_sphinx_theme-1.7.0.tar.gz
Algorithm Hash digest
SHA256 8ff959f9af58e39f81bdf5311e1c22f20688e951803e68664fa9b3dc0fda169b
MD5 74fc6a4dc9b2d817d4fd5bf31bc5f4e8
BLAKE2b-256 7982f5a9e546d9602b55166dda1951229a1294c81d640be9df62a58741ef7fae

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_sphinx_theme-1.7.0.tar.gz:

Publisher: ci_cd.yml on ansys/ansys-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ansys_sphinx_theme-1.7.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_sphinx_theme-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e346943742f16a1e74b2d9f4d29e0c984c6a47b1c4229ac8909a88c0202e7ae9
MD5 c34eb1fd1a16ff1cb5119bf7345934b4
BLAKE2b-256 87e7752ed2191ffc98835ba45504d7562ff8df3fccb51033b8b84b6f1582543d

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_sphinx_theme-1.7.0-py3-none-any.whl:

Publisher: ci_cd.yml on ansys/ansys-sphinx-theme

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page