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://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

0.0.1 - 2018-01-17

  • Initial development/testing version.

Project details


Download files

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

Files for sphinxcontrib-simpleversioning, version 0.0.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_simpleversioning-0.0.2-py2.py3-none-any.whl (6.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-simpleversioning-0.0.2.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page