Skip to main content

Ansys Sphinx theme

Ansys Python PyPI GH-CI MIT Black

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

In addition to installation information, the Ansys Sphinx theme documentation provides information on how you can customize the theme. Because this documentation is created using this theme, viewing it is an easy way to preview the theme itself.

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.support@ansys.com.

Getting started

Install the ansys-sphinx-theme package with:

python -m pip install ansys-sphinx-theme

Modify your Sphinx conf.py file to use html_theme = 'ansys_sphinx_theme'.

Development and contributions

If you want to contribute to the PyAnsys Sphinx theme, install the ansys-sphinx-theme package in development mode with:

git clone https://github.com/ansys/ansys-sphinx-theme.git
python -m pip install -U pip tox
tox -e style,doc

To simplify checks, this repository uses pre-commit. You can optionally install and use this tool. For more information, see its installation and usage documentation.

Before contributing to a PyAnsys library, see Contributing in the PyAnsys Developer’s Guide for overall guidance, paying particular attention to How-to for guidelines and best practices.

License

This theme is licensed under the MIT License.

Metadata

Release files for ansys-sphinx-theme 0.16.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ansys-sphinx-theme 0.16.0
File Size Uploaded Provenance Actions
ansys_sphinx_theme-0.16.0.tar.gz 729.4 kB Without provenance Details for ansys_sphinx_theme-0.16.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ansys-sphinx-theme 0.16.0
File Interpreter ABI Platform Actions
ansys_sphinx_theme-0.16.0-py3-none-any.whl Python 3 none any Details for ansys_sphinx_theme-0.16.0-py3-none-any.whl

Total release size: 1.5 MB

Release files / ansys_sphinx_theme-0.16.0.tar.gz

Download URL ansys_sphinx_theme-0.16.0.tar.gz
Size 729.4 kB
Tags Source
SHA-256 checksum
How to use checksums
3fd85b2cfb801bda700ba6fe96e795a93c393fabd80ddda3006b18781c100901
BLAKE2b-256 checksum
How to use checksums
2ae724b0ae4349e029a9c6cf5c8194439c1b75c317e20654d6eec98f5d4e77c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Release files / ansys_sphinx_theme-0.16.0-py3-none-any.whl

Download URL ansys_sphinx_theme-0.16.0-py3-none-any.whl
Size 745.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
594061e401c6a038e3e5c8a837e8af361d2c5376d44e024c921504751ff35215
BLAKE2b-256 checksum
How to use checksums
b8a81abf04874d44dafba07dec4059d4eeba2aa229f1c7cb0f89d4f054dba7b2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.10.14

Security for ansys-sphinx-theme 0.16.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.16.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page