Skip to content

Latest commit

 

History

History
173 lines (123 loc) · 5.87 KB

README.rst

File metadata and controls

173 lines (123 loc) · 5.87 KB
Raw

sphinxcontrib-versioning

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.
  • Python 2.7, 3.3, 3.4, and 3.5 supported on Windows (both 32 and 64 bit versions of Python).

📖 Full documentation: https://robpol86.github.io/sphinxcontrib-versioning

Build Status Windows Build Status Coverage Status Latest Version

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.2.1 - 2016-12-10

Added
  • Time value of html_last_updated_fmt will be the last git commit (authored) date.
Fixed

2.2.0 - 2016-09-15

Added
  • Windows support.
Fixed

2.1.4 - 2016-09-03

Fixed

2.1.3 - 2016-08-24

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

2.1.2 - 2016-08-24

Fixed
  • 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

Added
  • Command line option: --push-remote
Fixed
  • 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

Added
  • 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
Changed
  • Root ref will also be built in its own directory like other versions. All URLs to root ref will point to the one in that directory instead of the root. More info: sphinx-contrib#15
  • Renamed Jinja2 context variable scv_is_root_ref to scv_is_root.
Fixed
Removed
  • Jinja2 context variables: scv_root_ref_is_branch scv_root_ref_is_tag

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.
  • sphinx-contrib#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.