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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ansys_sphinx_theme-1.8.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.13

File hashes

Hashes for ansys_sphinx_theme-1.8.0.tar.gz
Algorithm Hash digest
SHA256 cc10b3cfbf742602a1cef6c3606227392d7bf8417d2f1561928ab791e852823c
MD5 c441a7ac9a6e3f54aaba4e7fbdc17657
BLAKE2b-256 874ac8095d3c073ef4fdd1795f84a03fd379d149f351b74e3fad2602aeb30ca8

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for ansys_sphinx_theme-1.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 09f7291999eb46cf010cfda0b20c36aa9e4a2796e8721efcda93978cba499cf3
MD5 ebbb34d6a74f4ed07d277728b24c4726
BLAKE2b-256 bbbc903221a893df2181b0a1ffc8323b05582afd6e7f5099a24be88df2ecd1bb

See more details on using hashes here.

Provenance

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