Skip to content

Releases: sphinx-contrib/sphinxcontrib-versioning

sphinxcontrib-versioning-2.2.1

10 Dec 09:39
Compare
Choose a tag to compare

Added

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

Fixed

  • Unhandled KeyError exception when banner main ref fails pre-build.
  • #26
  • #27

sphinxcontrib-versioning-2.2.0

16 Sep 03:25
Compare
Choose a tag to compare

Added

  • Windows support.

Fixed

sphinxcontrib-versioning-2.1.4

03 Sep 20:55
Compare
Choose a tag to compare

Fixed

  • banner.css being overridden by conf.py: #23

sphinxcontrib-versioning-2.1.3

25 Aug 06:20
Compare
Choose a tag to compare

Fixed

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

sphinxcontrib-versioning-2.1.2

24 Aug 07:53
Compare
Choose a tag to compare

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).

sphinxcontrib-versioning-2.1.1

24 Aug 00:44
Compare
Choose a tag to compare

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.

sphinxcontrib-versioning-2.1.0

22 Aug 22:33
Compare
Choose a tag to compare

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: #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

sphinxcontrib-versioning-2.0.0

15 Aug 07:32
Compare
Choose a tag to compare

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.
  • #16

sphinxcontrib-versioning-1.1.0

08 Aug 04:26
Compare
Choose a tag to compare
  • 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.
  • Fixed #5

sphinxcontrib-versioning-1.0.1

03 Aug 02:41
Compare
Choose a tag to compare
  • Fixed easy_install.