sphinx-versioned-docs

A Sphinx extension that lets you build Sphinx docs for all versions of your project without needing special hosting services.

Project Links

• Documentation: https://sphinx-versioned-docs.readthedocs.io/en/latest/

• Source code: https://github.com/devanshshukla99/sphinx-versioned-docs

• PyPI homepage: https://pypi.org/project/sphinx-versioned-docs/

• conda-forge: https://anaconda.org/conda-forge/sphinx-versioned-docs

General

• Installation
  • Requirements
  • 1. Installing using pip
  • 2. Installing using conda
  • 3. Installing from source
  • 4. Installing the developer version
• Tutorial
  • Building versioned docs
  • Deploy to github pages via github actions
• Settings
  • Configuration File Arguments
  • Command Line Arguments
• Supported themes
• API documentation
  • Entry application
  • Building workflow
  • Sphinx extension
  • Utiliies/ Libraries

Appendix

• How to contribute
• Changelog