Welcome to the Docs Versions Menu documentation

A versions-menu for Sphinx-based documentation.

Table of Contents

• Getting Started
  • Installation
  • Usage
  • Default assumptions
  • Examples
• Step 1: Sphinx extension
  • Sphinx themes
  • Settings in conf.py
• Step 2: Deployment
  • Deployment with Github Actions
  • Github Releases
  • Deployment with Travis and Doctr
  • Deployment to a static webhost
  • Interactive maintenance
• Program Options
  • docs-versions-menu
  • Download links
  • Debugging
  • Folders
  • Menu labels
  • Custom warning messages
• Folder Specifications
  • Group Names
  • Folder Names
  • Conditionals
  • Slice-Expressions
  • Sort-Groupings
• versions.json Structure
• Templates
  • index.html template
  • docs-versions-menu.js template
• Related software
  • Alternatives
• Contributing
  • Code of Conduct
  • Report Bugs
  • Development Guidelines
• History
  • 0.5.2 (2023-04-19)
  • 0.5.1 (2023-01-25)
  • 0.5.0 (2022-11-17)
  • Migration from doctr-versions-menu
  • 0.4.1 (2021-03-18)
  • 0.4.0 (2020-12-14)
  • 0.3.0 (2020-08-03)
  • 0.2.0 (2020-03-14)
  • 0.1.0 (2020-01-11)
• Credits