Sphinx extension and command to add a versions menu to Doctr-deployed documentation
Project description
History
0.2.0-rc2 (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.2.0rc2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf80ccfe384cf353222b76f843499b1495572ab5954d2c05bfd83609ed75eef9 |
|
MD5 | 3017bce3cf5091667fd8d22acedbc9e3 |
|
BLAKE2b-256 | f69d3efd976123c5cf9734e168a1c47115ffe32321698231faba58372c519e60 |
Hashes for doctr_versions_menu-0.2.0rc2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 240906b52221f8500240551797400390bef2d3b64ad5d91925490a6125d87f36 |
|
MD5 | 6f6456e45d9c7bc034623fdb7adfbf2a |
|
BLAKE2b-256 | e8c180855e0f5199d4f327db980fd12007b67c36f91a2c31d3b8426ec333ddd1 |