Readthedocs builds don't fetch tags when cloning the repo. This is a problem
for us because Rockcraft's version comes from the tag (via setuptools-scm),
so do a fetch of the tags as a post-checkout step.
docs: use "dev" for non-release builds
The bug is this: If a build is done off of (say) 'main', the version coming
from 'git describe' will be something like 1.32.2.postXXXX. We previously
dropped the ".post" suffix because it confused the spellchecker but that
just leaves the misleading "1.32.2" string. It's misleading because that's
an actual released version that does not* contain a lot of the content
in 'main'.
So just use "dev" instead, to make it extra explicit that the docs refer
to an unreleased version of the software.
Fixes #584
For reference, this is the setting in RDT's configuration page that makes "stable" be the default version:
This PR contains two commits:
Readthedocs builds don't fetch tags when cloning the repo. This is a problem for us because Rockcraft's version comes from the tag (via setuptools-scm), so do a fetch of the tags as a post-checkout step.
The bug is this: If a build is done off of (say) 'main', the version coming from 'git describe' will be something like 1.32.2.postXXXX. We previously dropped the ".post" suffix because it confused the spellchecker but that just leaves the misleading "1.32.2" string. It's misleading because that's an actual released version that does not* contain a lot of the content in 'main'.
So just use "dev" instead, to make it extra explicit that the docs refer to an unreleased version of the software.
Fixes #584
For reference, this is the setting in RDT's configuration page that makes "stable" be the default version: