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 2.7, 3.3, 3.4, and 3.5 supported on Linux and OS X.

📖 Full documentation:

Build Status Coverage Status Latest Version



pip install sphinxcontrib-versioning


sphinx-versioning --help
sphinx-versioning build --help
sphinx-versioning push --help


This project adheres to Semantic Versioning.

2.1.4 - 2016-09-03


2.1.3 - 2016-08-24

  • Stopped blocking users from overriding their layout.html. Using another approach to inserting the banner.

2.1.2 - 2016-08-24

  • Cloning from push remote instead of origin. If HTML files are pushed to another repo other than origin it doesn’t make sense to clone from origin (previous files won’t be available).

2.1.1 - 2016-08-23

  • Command line option: --push-remote
  • Copy all remotes from the original repo to the temporarily cloned repo when pushing built docs to a remote. Carries over all remote URLs in case user defines a different URL for push vs fetch.

2.1.0 - 2016-08-22

  • Option to enable warning banner in old/development versions. Similar to Jinja2’s documentation.
  • Command line options: --banner-greatest-tag --banner-recent-tag --show-banner --banner-main-ref
  • Jinja2 context functions: vhasdoc() vpathto()
  • Jinja2 context variables: scv_show_banner scv_banner_greatest_tag scv_banner_main_ref_is_branch scv_banner_main_ref_is_tag scv_banner_main_version scv_banner_recent_tag
  • Jinja2 context variables: scv_root_ref_is_branch scv_root_ref_is_tag

2.0.0 - 2016-08-15

  • --git-root command line option.
  • --whitelist-branches and --whitelist-tags command line options.
  • --local-conf and --no-local-conf command line options.
  • Load settings from file and command line arguments instead of just the latter.
  • Renamed command line option --prioritize to --priority.
  • Renamed command line option -S to -s.
  • --chdir, --no-colors, and --verbose must be specified before build/push and the other after.
  • --sort no longer takes a comma separated string. Now specify multiple times (like --grm-exclude).
  • Renamed --sort value “chrono” to “time”.
  • Reordered positional command line arguments. Moved REL_SOURCE before the destination arguments.
  • Renamed command line option -C to -N for consistency with sphinx-build.

1.1.0 - 2016-08-07

  • Exposing Jinja2 context variables: scv_is_branch scv_is_root_ref scv_is_tag scv_root_ref_is_branch scv_root_ref_is_tag scv_is_greatest_tag scv_is_recent_branch scv_is_recent_ref scv_is_recent_tag
  • Version links point to that version of the current page if it exists there.

1.0.1 - 2016-08-02


1.0.0 - 2016-07-23

  • Initial release.

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-versioning, version 2.1.4
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-versioning-2.1.4.tar.gz (23.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page