An opinionated template for creating a modern Sphinx documentation project. Write in Markdown or reStructuredText, translate to multiple languages, boost with popular extensions, and enjoy automatic live reload on change.
Default blank Sphinx documentation project needs a lot of configuration, fine-tuning, trials, and fails before setting up everything for best results. This template results from the best practices and knowledge we gained by providing Documatt's technical writing services.
📚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, Copier dependency jinja2_time, is uv. The uv can even install Python if you don't already have it.
With uv installed, open the terminal and
uvx --with jinja2-time copier copy --trust https://github.com/documatt/sphinx-doc-template my-new-docs
Answer the series of questions, and you are ready to go. You have the skeleton of a completely functional Sphinx project in my-new-docs folder in just a few moments.
The Sphinx documentation template key features:
- 💯 Free & open-source.
- ✍️ Write in Markdown or reStructuredText.
- 🏗️ Comes with popular Sphinx extension for sitemaps, redirects, diagrams, etc.
- 👅 Localization (i18n) support.
- 😀 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.
Are you looking for a theme template instead? See also our sphinx-theme-template.
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 to see featured material and upcoming events.
Join our community here:
- 🌟 Explore our GitHub
- 📥 Subscribe to our newsletter
- 🐦 Follow us on X
- 🕴️ Follow us on LinkedIn
- 📺 Subscribe to our YouTube channel
- 📚 Read our blog posts
The project is MIT-licensed.
Icon "copy" by TabletIcons.