Registry / web-framework / ansys-sphinx-theme

ansys-sphinx-theme

library1.7.2pypypi✓ verified 48d ago

A Sphinx theme devised by ANSYS, Inc. for documenting PyAnsys libraries and other projects. Version 1.7.2 requires Python >=3.10,<4. The theme provides a modern, responsive design with PyAnsys branding, including custom components like a version switcher, search, and navigation. It follows a monthly release cadence.

web-framework devops

pip install ansys-sphinx-theme

github ↗package ↗homepage ↗docs ↗

Install & Compatibility

Where this runs

tested against v1.9.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 1.182s · 126.1MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 7.0s · import 1.080s · 128MB

128MB installed

● package 128MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

ansys_sphinx_theme

✓ import ansys_sphinx_theme

Basic setup in Sphinx conf.py to use the theme.

import ansys_sphinx_theme # conf.py extensions = [ 'ansys_sphinx_theme', ] html_theme = 'ansys_sphinx_theme' html_theme_options = { 'github_url': 'https://github.com/ansys/ansys-sphinx-theme', }

Debug

Known issues

breakingVersion 1.7.0 introduced dependency groups and may require updating your pyproject.toml or requirements if you relied on old optional extras.

fix

Check the new dependency groups in the repository's pyproject.toml and adjust your project dependencies accordingly.

affects: >=1.7.0

deprecatedSupport for Python 3.9 is dropped starting from version 1.7.0. Use Python >=3.10.

fix

Update Python to 3.10 or later.

affects: >=1.7.0

gotchaThe theme expects a specific folder structure for static files; custom CSS/JS may be overwritten during theme updates. Always use custom CSS with the `html_static_path` setting.

fix

Place custom files in `_static` and reference them via `html_css_files` or `html_js_files` in conf.py.

affects: all

Errors

Common errors & fixes

ModuleNotFoundError: No module named 'ansys_sphinx_theme'

The package is not installed or installed in a different environment.

fix

Run `pip install ansys-sphinx-theme` and ensure the correct Python environment is active.

Theme 'ansys_sphinx_theme' is not registered

The extension is not added to the extensions list in conf.py.

fix

Add `'ansys_sphinx_theme'` to the `extensions` list in your conf.py.

Sphinx version incompatibility: ansys-sphinx-theme requires sphinx>=4.0

Older versions of Sphinx are not supported.

fix

Upgrade Sphinx: `pip install -U sphinx`

Upgrade

Version history

1.9.0latest on PyPI

Audit

Dependencies

sphinxrequiredRequired core dependency for the theme

sphinx-autoapioptionalOften used together for API documentation; not a hard dependency but common

Agent activity

15 hits · last 30 days

node

ahrefsbot

Amazon

amazonbot

Resources

githubhttps://github.com/ansys/ansys-sphinx-theme ↗

packagehttps://pypi.org/project/ansys-sphinx-theme/ ↗

homepagehttps://sphinxdocs.ansys.com/ ↗

docshttps://sphinxdocs.ansys.com/ ↗