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: https://robpol86.github.io/sphinxcontrib-versioning
Quickstart
Install:
pip install sphinxcontrib-versioning
Usage:
sphinx-versioning --help
sphinx-versioning build --help
sphinx-versioning push --help
Changelog
This project adheres to Semantic Versioning.
2.0.0 - 2016-08-15
- Added
--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 conf.py file and command line arguments instead of just the latter.
- Changed
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.
- Fixed
Exposing sphinx-build verbosity to SCVersioning. Specify one -v to make SCVersioning verbose and two or more to make sphinx-build verbose.
Using --no-colors also turns off colors from sphinx-build.
https://github.com/Robpol86/sphinxcontrib-versioning/issues/16
1.1.0 - 2016-08-07
- Added
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
- Changed
Version links point to that version of the current page if it exists there.
- Fixed
1.0.1 - 2016-08-02
- Fixed
1.0.0 - 2016-07-23
Initial release.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinxcontrib-versioning-2.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1ca0618b7178d94b65095aafabaee3b34d42cbb93962acd0c423baca621fcc73 |
|
MD5 | a5562508ca515f7e9473e6c16f1465a3 |
|
BLAKE2b-256 | 02dffee794d81ee9cd7f0815fc76d38e00643b1cc448daa99d74d7d59db99b27 |