sphinx-multiversion 0.2.5

A Sphinx extension for building self-hosted versioned documentation.

Project Links

• Source code: https://github.com/sphinx-contrib/multiversion

General

• Installation
  • Install from PyPi
  • Install from GitHub
  • Install from local clone
• Quickstart
• Configuration
  • Tag/Branch/Remote whitelists
  • Release Pattern
  • Output Directory Format
  • Overriding Configuration Variables
• Templates
  • Version Listings
    • List all branches/tags
    • List branches and tags separately
    • List releases and development versions separately
  • Version Banners
  • ReadTheDocs Theme
• HTML Context
  • Version Objects
    • name
    • url
    • version
    • release
    • is_released
  • Versions
    • versions
    • versions.branches
    • versions.tags
    • versions.releases
    • versions.in_development
  • Functions
    • vhasdoc()
    • vpathto()
  • Other Variables
    • current_version
    • latest_version

Appendix

• Hosting on GitHub Pages
• Frequently Asked Questions
• Changelog