Skip to main content

Sphinx extension that allows building versioned docs for self-hosting.

Project description

Sphinx extension that allows building versioned docs for self-hosting.

  • Python 3.4, and 3.5 supported on Linux and OS X.

  • Python 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).

Full documentation: https://sphinx-versions.readthedocs.io

This project is, for the most part, a fork of https://github.com/Robpol86/sphinxcontrib-versioning, with some additions and removals.

How to use

Most basic usage:

sphinx-versions --help
sphinx-versions build --help

Changelog

This project adheres to Semantic Versioning.

1.1.3 - 2019-07-18

Changes
  • Fix pdf copy target directory

1.1.2 - 2019-07-18

Changes
  • Removes the rest of unicode function calls

1.1.1 - 2019-07-18

Changes
  • Removes compatibility with Python 2 (and make it work properly on Pyhton 3 : removing a call to unicode function)

1.1.0 - 2019-07-18

Changes
  • Add -P pdf-file-name.pdf option, thanks to Anybotics fork <https://github.com/ANYbotics/sphinx-versions>

1.0.1 - 2019-04-23

Changes
  • Update sphinx version from 1.8.4 to 1.8.5

1.0.0 - 2018-12-08

Changes
  • From sphinxcontrib-versionning v2.2.1, added compatibility with Sphinx 1.8.2.

  • From sphinxcontrib-versionning v2.2.1, removed push commands, considered not core for our own usage.

  • Migrates to pipenv as the recommanded installation process.

  • Use -s option instead of –no-patch in git show (this is for git 1.8.3.1 compatibility).

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

sphinx-versions-1.1.3.tar.gz (22.3 kB view details)

Uploaded Source

Built Distribution

sphinx_versions-1.1.3-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-versions-1.1.3.tar.gz.

File metadata

  • Download URL: sphinx-versions-1.1.3.tar.gz
  • Upload date:
  • Size: 22.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

File hashes

Hashes for sphinx-versions-1.1.3.tar.gz
Algorithm Hash digest
SHA256 f51385123113f9dd837e0e031f1d08a94377e281b06380066e2eed78ae18991f
MD5 4e29afff67bb810316c70a212b3bdc48
BLAKE2b-256 79ff4af642bde194a9c264133841e9a3ad7369372a2bf68146f7dfbc8ef079aa

See more details on using hashes here.

File details

Details for the file sphinx_versions-1.1.3-py3-none-any.whl.

File metadata

  • Download URL: sphinx_versions-1.1.3-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.6.2 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.2

File hashes

Hashes for sphinx_versions-1.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 db7d0c698e540a45ccf61ddbf2cab79fcd23222df59324f752ef918410ee4f0f
MD5 a41cd686702b7ec2f7bf010c0d454254
BLAKE2b-256 93aa8fc287aec06ce1945f2e99907ceab6039f40bf16c4d5ed16c203db979072

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