Sphinx Theme Template#
A Copier template for creating modern Sphinx documentation themes with Tailwind CSS. It offers scaffolding for new themes, streamlines their development and testing, and gives a rich developer experience with debugging and automatic live reloading during development.
Developing custom Sphinx documentation themes can be challenging. The Sphinx theme is a collection of Python code, Jinja templates, and frontend HTML, JS, and CSS. This template offers scaffolding for new themes, streamlines Python and web tooling and building, and speeds up their development and testing.
This template results from the best practices and knowledge we gained by providing Sphinx hosting and custom Sphinx theme development at Documatt.
📚Documentation · 📟 Source code
The repository is the Copier template. Copier is a command-line tool for creating projects from templates. It requires Python installed, but no knowledge of Python to use.
The recommended way to install the Copier is uv. The uv can even install Python if you don’t already have it.
With uv installed, open the terminal and
uvx copier copy gh:documatt/sphinx-theme-template my-new-theme
Answer the series of questions, and you are ready to go. You have the skeleton of a completely functional Sphinx theme in my-new-theme folder in just a few moments. Use . for the current folder.
Key Features#
Main Sphinx theme template features:
💯 Free & open-source.
✍️ Modern Node.js frontend tooling with Tailwind CSS.
🏗️ Modern Python setup with
pyproject.toml, pytest, etc.📒 The real-world documentation sample to test themes.
😀 Sane configuration defaults and best practices.
🎨 VS Code support: recommended extensions, settings, and formatting.
⚒️ Live reload on change.
💾 Build to multiple outputs.
👍 Works out-of-the-box.
Learn more in 📚documentation.
Sphinx Documentation Template#
Are you looking for a documentation template instead? See also our sphinx-doc-template.
Community and contributions#
Bug reports, feature requests, or all contributions are welcome at our 📟 GitHub homepage.
Connect with other fellows who are building with Sphinx. Share knowledge, get help, and contribute to the open-source project. Check out our Documatt Community page for featured material and upcoming events.
Join our community here:
Legal#
The project is MIT-licensed.
Icon “copy” by TabletIcons.
Contents:
