Welcome to the Doctr Versions Menu documentation

Sphinx extension and command to add a versions menu to Doctr-deployed documentation.

Warning

As of December 2020, Travis no longer provides free services to open source projects. See Deployment with Github Actions for a workaround.

Table of Contents

• Doctr Versions Menu
  • Installation
  • Usage
  • Examples
• Contributing
  • Code of Conduct
  • Report Bugs
  • Development Guidelines
• Credits
• History
  • 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)
• Step 1: Sphinx extension
  • Sphinx themes
  • Customization
• Step 2: Deployment
  • doctr-versions-menu
  • Deployment with Github Actions
  • Command line options
  • Debugging
  • Default assumptions
  • Customization
  • Download links
  • Folders included in the menu
  • Labels in the versions menu
  • Custom warning messages
  • Customizing index.html
  • Maintenance on gh-pages
• Folder Specifications
  • Group Names
  • Folder Names
  • Conditionals
  • Slice-Expressions
  • Sort-Groupings
• versions.json Structure
• Documentation Artifacts
  • Building artifacts
  • Uploading artifacts
• Related software