doctr-versions-menu 0.1.0rc1

Sphinx extensions and utility to add a versions menu to Doctr-deployed documentation

Doctr Versions Menu

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

Development of Doctr Versions Menu happens on Github. You can read the full documentation online.

⚠️ WARNING: This implementation is work in progress. No public release is available at this time, nor should the current development version (master) be considered functional.

Installation

To install the latest released version of doctr-versions-menu, run this command in your terminal:

$ pip install doctr_versions_menu

This is the preferred method to install Doctr Versions Menu, as it will always install the most recent stable release.

If you don’t have pip installed, the Python installation guide, respectively the Python Packaging User Guide can guide you through the process.

To install the latest development version of doctr-versions-menu from Github.

$ pip install git+https://github.com/goerz/doctr_versions_menu.git@master#egg=doctr_versions_menu

Usage

Showing a versions menu in your documentation requires two steps:

1. Add 'doctr_versions_menu' to the list of extensions in your Sphinx conf.py.

2. Call the doctr-versions-menu command as part of doctr deploy.

See the full documentation for Step 1 and Step 2 for details.

History

0.1.0-rc1 (2020-01-08)

• Placeholder release