Skip to main content

Sphinx extension that adds version selection.

Project description

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://sphinxconfig-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.1 - 2017-01-17

  • Initial development/testing version.

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_simpleversioning-0.0.1-py2.py3-none-any.whl (11.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
sphinxcontrib-simpleversioning-0.0.1.tar.gz (6.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page