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.8.2.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.8.2-py3-none-any.whl (1.6 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ansys_sphinx_theme-1.8.2.tar.gz
Algorithm Hash digest
SHA256 73570863d8a4f5f723826723f44cf5666c4e9b443dbc66fd3640f12d4241b7c4
MD5 c1df0eaf5b4cd31348a501c014fcf418
BLAKE2b-256 f8d91e8012e7290237eb85257f3e6c531b5f309d8f37dc7174802a536249bdce

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_sphinx_theme-1.8.2.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.8.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_sphinx_theme-1.8.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cdc2553586700c3b5e9a594ccfa3255fdb6aefd7fc4431494f4c847754bf7718
MD5 e728cc41e17c2e8e7d457b1fe335c051
BLAKE2b-256 4636f6078d23d06d2490c5ba4b893f422febbd015b41f34c4e9f99ac6a9dd18a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_sphinx_theme-1.8.2-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