Sphinx Polyversion

Build multiple versions of your sphinx docs and merge them into one website.

  • Isolated builds using venv, virtualenv or poetry

  • git support

  • Build with sphinx-build or custom commands

  • Access and modify all versioning data inside conf.py

  • Concurrent builds

  • Override build configuration from commandline easily

  • Render templates to the root directory containing the docs for each version

  • Build from local working tree easily while mocking version data

  • Not a sphinx extension -> standalone tool

  • Configuration in a python script

  • Highly customizable and scriptable through OOP

  • Implement subclasses in your configuration script to add support for other VCS, Project/dependency management tools, build tools and whatever you require

  • IDE integration and autocompletion

Table of Contents

Development

Links