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

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.12.5
File Size Uploaded Provenance Actions
ansys_sphinx_theme-0.12.5.tar.gz 726.3 kB Without provenance Details for ansys_sphinx_theme-0.12.5.tar.gz

Built distribution (wheel)

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

Total release size: 1.5 MB

Release files / ansys_sphinx_theme-0.12.5.tar.gz

Download URL ansys_sphinx_theme-0.12.5.tar.gz
Size 726.3 kB
Tags Source
SHA-256 checksum
How to use checksums
81e50f7cc9812a39ed02a4f3894c9a64bec2ff8d0402877cd90c6cc988ddac6d
BLAKE2b-256 checksum
How to use checksums
9cfcd53c0deea914576fc50d8a192d9c2b7dbc759595a7bcf998299b662d1f8b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.13

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

Download URL ansys_sphinx_theme-0.12.5-py3-none-any.whl
Size 736.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8b18c2c5b6eeffc382bd1b9fa4a860783a4a785a859c3530fce3bef06ebb7f80
BLAKE2b-256 checksum
How to use checksums
9066d97e5a6716a40c4fa73b7aef5578f5f0fefe7ce96d66716db414fe95903b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.10.13

Security for ansys-sphinx-theme 0.12.5

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