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.

Source Distribution

sphinxcontrib-simpleversioning-0.0.2.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_simpleversioning-0.0.2-py2.py3-none-any.whl (6.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-simpleversioning-0.0.2.tar.gz.

File metadata

  • Download URL: sphinxcontrib-simpleversioning-0.0.2.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.13

File hashes

Hashes for sphinxcontrib-simpleversioning-0.0.2.tar.gz
Algorithm Hash digest
SHA256 f66ffbad04860b5d9117361c1e53b26e746740ba3bad78fd9f0a1b40e38931fe
MD5 ef296c2476d1444b80b338da0d191d36
BLAKE2b-256 ab65dedf70fac47ce96a5cfb0b6ac521653fadadd1a16d52cf1fedb78d62ed93

See more details on using hashes here.

File details

Details for the file sphinxcontrib_simpleversioning-0.0.2-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_simpleversioning-0.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/2.7.13

File hashes

Hashes for sphinxcontrib_simpleversioning-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 bee63de9b217027adce77b7785093370db37362e543134bba39ec3c20fe5534d
MD5 09d1e7c390f2802368378e491557a75d
BLAKE2b-256 39f30bd7f6aef912521e74e8bd9b895c7d525e800eca7d722f2a73d607db0b38

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page