doctr-versions-menu 0.2.0rc2

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

Doctr Versions Menu

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

Doctr is a tool that deploys Sphinx documentation from Travis CI to Github Pages. It is an alternative to the popular Read the Docs (RTD). Compared to RTD, Doctr gives full control over the documentation build process. However, Doctr out of the box does not support documentation for multiple versions of a package at the same time (unlike RTD).

The doctr-versions-menu package aims to remedy this. It provides a Sphinx extension and a command line tool that work together to generate a dynamic versions menu similar to that on RTD pages:

It also injects warnings for outdated or unreleased versions.

See the doctr-versions-menu documentation itself for a live example.

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

Installation

To install the latest released version of doctr-versions-menu, run:

pip install doctr-versions-menu

Or, 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

In practice, you probably only have to install the doctr-versions-menu package on Travis, for generating and deploying the documentation; or, e.g., in a local tox environment for generating documentation locally during development.

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.

   This adds javascript to your rendered documentation that displays a dynamic versions menu based on information in a versions.json file it expects to find in the root for your gh-pages branch.

2. Call the doctr-versions-menu command as part of doctr deploy (in .travis.yml).

   For example,

   doctr deploy --command=doctr-versions-menu --no-require-master --build-tags "$DEPLOY_DIR"

   This causes doctr-versions-menu to be executed in the root of the gh-pages branch. The script examines the folders that exist there, and generates the versions.json file that step 1 relies on.

See the full documentation on Step 1 and Step 2 for details. However, for projects that follow normal best practices, you should not require any customization beyond the above two steps.

History

0.2.0-rc2 (2020-03-14)

• Added: --versions option for customizing which folders appear in the versions menu and in which order.

• Added: --label option for customizing the labels appearing the versions menu

• Added: --warning option for customizing on which folders specific warnings are displayed

• Added: --latest option for configuring which folder is the “latest stable release”

• Added: Write a script versions.py to the root of the gh-pages branch (--write-versions-py option)

• Changed: unreleased and pre-released versions now show different warnings by default

• Changed: index.html template is now rendered with full version_data

• Changed: development/pre-release versions now longer have the “dev” suffix in the versions menu by default

• Changed: The versions menu now uses the same ordering of versions as Read-the-Docs, by default: the folders are ordered from most current to least current.

• Changed: internal format of versions.json

• Removed: --default-branch option. This is replaced by the new --latest option and enhanced template rendering of the index.html

• Removed: --suffix-unreleased option. This can now be achieved via the --label option

This is a major release that breaks backwards compatibility.

Specifically, due to the changes in versions.json, when upgrading from older versions, it may be necessary to replace doctr-versions-menu.js files in existing folders in a project’s gh-pages branch.

0.1.0 (2020-01-11)

• Initial release