sphinx-hextra 0.1.0.dev0

A Sphinx theme and directive set bringing the Hextra aesthetic to Sphinx, with sphinx-needs integration.

sphinx-hextra

A Sphinx HTML theme and component directive set that brings the aesthetic of the Hextra Hugo theme to the Sphinx documentation ecosystem, with first-class styling for sphinx-needs.

sphinx-hextra is a derivative work. Visual design, component concepts, and CSS structure are ported from Hextra (MIT, © Imfing and contributors). The upstream LICENSE is preserved verbatim at licenses/HEXTRA-LICENSE. See CREDITS.md for full attribution.

Install

uv add sphinx-hextra

Use

In your conf.py:

extensions = ["myst_parser", "sphinx_hextra"]
html_theme = "sphinx_hextra"

Features (v0.1)

• Hextra-inspired layout, typography, and dark mode
• Directives: hextra-callout, hextra-cards + hextra-card, hextra-tabs, hextra-steps, hextra-filetree
• Landing-page directives: hextra-hero, hextra-feature-grid, hextra-feature
• Automatic sphinx-needs integration styling (when sphinx_needs is enabled)
• Zero Node.js dependency for end users — CSS is precompiled

Credits

This project stands on the shoulders of Hextra. Every design decision traces back to their work. Bugs here are ours; beauty is theirs.

License

MIT. See LICENSE (sphinx-hextra) and licenses/HEXTRA-LICENSE (upstream Hextra).