Sphinx Documentation Template#

Project hero image

An opinionated Copier 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 projects require extensive configuration, fine-tuning, and trial and error to achieve optimal results. This template embodies the best practices and expertise gained through Documatt’s technical writing services.

📚 Documentation · 📟 Source code

Made with Copier badge GitHub Repo stars badge GitHub tests badge Code style Prettier badge MIT licence badge

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 --trust gh: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.

🍿 Watch#

How to create Sphinx documentation from a template

How to preview Sphinx documentation?

Key Features#

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.

Sphinx Theme Template#

Are you looking for a theme template instead? See also our sphinx-theme-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 to see featured material and upcoming events.

Join our community here: