{"id":23253,"library":"ansys-sphinx-theme","title":"Ansys Sphinx Theme","description":"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.","status":"active","version":"1.7.2","language":"python","source_language":"en","source_url":"https://github.com/ansys/ansys-sphinx-theme","tags":["sphinx","theme","ansys","documentation"],"install":[{"cmd":"pip install ansys-sphinx-theme","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required core dependency for the theme","package":"sphinx","optional":false},{"reason":"Often used together for API documentation; not a hard dependency but common","package":"sphinx-autoapi","optional":true}],"imports":[{"note":"","wrong":"","symbol":"ansys_sphinx_theme","correct":"import ansys_sphinx_theme"}],"quickstart":{"code":"import ansys_sphinx_theme\n\n# conf.py\nextensions = [\n    'ansys_sphinx_theme',\n]\nhtml_theme = 'ansys_sphinx_theme'\nhtml_theme_options = {\n    'github_url': 'https://github.com/ansys/ansys-sphinx-theme',\n}","lang":"python","description":"Basic setup in Sphinx conf.py to use the theme."},"warnings":[{"fix":"Check the new dependency groups in the repository's pyproject.toml and adjust your project dependencies accordingly.","message":"Version 1.7.0 introduced dependency groups and may require updating your pyproject.toml or requirements if you relied on old optional extras.","severity":"breaking","affected_versions":">=1.7.0"},{"fix":"Update Python to 3.10 or later.","message":"Support for Python 3.9 is dropped starting from version 1.7.0. Use Python >=3.10.","severity":"deprecated","affected_versions":">=1.7.0"},{"fix":"Place custom files in `_static` and reference them via `html_css_files` or `html_js_files` in conf.py.","message":"The 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.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run `pip install ansys-sphinx-theme` and ensure the correct Python environment is active.","cause":"The package is not installed or installed in a different environment.","error":"ModuleNotFoundError: No module named 'ansys_sphinx_theme'"},{"fix":"Add `'ansys_sphinx_theme'` to the `extensions` list in your conf.py.","cause":"The extension is not added to the extensions list in conf.py.","error":"Theme 'ansys_sphinx_theme' is not registered"},{"fix":"Upgrade Sphinx: `pip install -U sphinx`","cause":"Older versions of Sphinx are not supported.","error":"Sphinx version incompatibility: ansys-sphinx-theme requires sphinx>=4.0"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}