sphinxcontrib-simpleversioning

Sphinx extension that allows adding version selection to docs.

• Python 2.7, 3.3, 3.4, and 3.5 supported

This is based on, but is a vastly simplified version of sphinxcontrib.versioning intended for building and publishing documentation with automation/continuous integration tools.

See the sphinxcontrib.versioning documentation if you need more features or would like to understand the differences.

📖 Full documentation: https://sphinxcontrib-simpleversioning.readthedocs.io/

Quickstart

Install:

pip install sphinxcontrib-versioning

Usage (in Sphinx conf.py):

extensions.append('sphinxcontrib.simpleversioning')
simpleversioning_versions = [
    'master',
    {'id': 'dev', 'name': 'latest'},
]

Changelog

This project adheres to Semantic Versioning.

0.0.2 - 2019-02-13

• Drop reference to unused banner.css from sphinxcontrib.versioning.

0.0.1 - 2018-01-17

• Initial development/testing version.