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.

Files for sphinx-versions, version 1.1.3
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_versions-1.1.3-py3-none-any.whl (27.4 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size sphinx-versions-1.1.3.tar.gz (22.3 kB) File type Source Python version None Upload date Hashes View hashes

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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page