Sphinx extension and command to add a versions menu to Doctr-deployed documentation
Project description
History
0.3.0 (2020-08-03)
Added: --no-downloads-file option, downloads_file = False in config. (#4, thanks to Tyler Pennebaker)
Fixed: versions.py on gh-pages branch was not being committed (#5)
Fixed: Compatibility with any pyparsing version >= 2.0.2 (#8, thanks to Hugo Slepicka)
Added: The doctr-versions-menu executable can now be configured through environment variables. This allows to keep configuration on the source branch, in the .travis.yml file (#6, thanks to Tyler Pennebaker)
The Doctr Versions Menu package can now be installed via conda (thanks to Hugo Slepicka)
0.2.0 (2020-03-14)
Added: --versions option for customizing which folders appear in the versions menu and in which order.
Added: --label option for customizing the labels appearing the versions menu
Added: --warning option for customizing on which folders specific warnings are displayed
Added: --latest option for configuring which folder is the “latest stable release”
Added: Write a script versions.py to the root of the gh-pages branch (--write-versions-py option)
Changed: unreleased and pre-released versions now show different warnings by default
Changed: index.html template is now rendered with full version_data
Changed: development/pre-release versions now longer have the “dev” suffix in the versions menu by default
Changed: The versions menu now uses the same ordering of versions as Read-the-Docs, by default: the folders are ordered from most current to least current.
Changed: internal format of versions.json
Removed: --default-branch option. This is replaced by the new --latest option and enhanced template rendering of the index.html
Removed: --suffix-unreleased option. This can now be achieved via the --label option
This is a major release that breaks backwards compatibility.
Specifically, due to the changes in versions.json, when upgrading from older versions, it may be necessary to replace doctr-versions-menu.js files in existing folders in a project’s gh-pages branch.
0.1.0 (2020-01-11)
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
Built Distribution
Hashes for doctr_versions_menu-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d49166b7a0a1a0ce14f37a5314d420de69421a1764307f91c9910a02852d7c95 |
|
MD5 | 964572d435189a6b916e692892d31726 |
|
BLAKE2b-256 | 087b242f9c5f5a8fb33ebb03cb16ab22aaed0685a4a2483640bf8b594ff6c74f |
Hashes for doctr_versions_menu-0.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e2c3005b24f07ee9f9d59dbea7449da27021e05d29ef6ac7cec4c1a68c509aa |
|
MD5 | be8652d41f797bb80beae99e9162375d |
|
BLAKE2b-256 | 66b1cc100a0b28817e89cb2ae8a1c8721c68bf10f73c3a5d1aef983fe83c505d |