From 1ef4b6d13b8167db28edbe65dc74b431df9167fa Mon Sep 17 00:00:00 2001 From: Tiago Nobrega Date: Tue, 18 Jun 2024 11:15:38 -0300 Subject: [PATCH] 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. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index fe45fc283..fb481cee7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -35,7 +35,7 @@ release = rockcraft.__version__ if ".post" in release: # The commit hash in the dev release version confuses the spellchecker - release = release[0 : release.find(".post")] + release = "dev" # region Configuration for canonical-sphinx ogp_site_url = "https://canonical-rockcraft.readthedocs-hosted.com/"