Sphinx extension

All of our projects deserve good docs and all of them should look like they were built by us.

confirm-sphinx is what gives all documentations this unified look and sane defaults. It’s a theme based on Furo plus a Sphinx extension, which configures Sphinx based on the GitLab CI/CD variables.

🤷🏻‍♂️ Why we built it

We’ve got several Sphinx documentations deployed. Copying the same conf.py, CSS and logos into every project means a lot of drift and a lot of manual updates. With this package, you install one dependency and get:

• A unified appearance: CI colours, fonts, logos and a dark mode.

• Less configuration: Author, copyright, release, extensions and source links are set for you.

• CI awareness: Release name, “view / edit source” links and todo visibility follow the current branch or tag.

Contents

• 🚀 Usage
  • Install the package
  • Use the extension (recommended)
  • Use the theme only
  • Upgrade from confirm.sphinx.defaults
• 🎛️ Defaults
  • CI/CD variables
  • Settings
  • Extensions
  • Todo visibility
• 🎨 Theme
  • What’s different from Furo
  • Options
  • Assets
• 🌈 Showcase
  • Headings
  • Text
  • Admonitions
  • Code
  • Tables
  • Diagrams
• 🔨 Development
  • Project structure
  • Set up your environment
  • Preview your changes
  • Change the styles
  • Change the defaults
  • Run the tests
  • Release