sphinxcontrib-versioning icon indicating copy to clipboard operation
sphinxcontrib-versioning copied to clipboard

Separate handling of release candidates

Open bmcfee opened this issue 7 years ago • 1 comments

As I understand it, we basically have two options for the "default" root version of the docs: master (or some other branch of choice) or the latest (or highest by semver ordering) tag.

This logic doesn't quite work when the latest tag is a pre-release and master is development. For example, I have a project where master is the development version, tag 0.4.3 is the latest stable release, and 0.5.0rc0 is the most recent tag. (I think this is not an uncommon scenario.) In this case, it would be nice to have an option to build docs for release candidates/pre-releases, but keep the default as the highest non-rc tag.

Does this seem reasonable, and would it be difficult to pull off?

(Unrelated: thanks for building this package. It's awesome!)

bmcfee avatar Feb 15 '17 15:02 bmcfee