[Doc,CI] Sanitize version (#762)

.github/workflows/docs.yml

@@ -78,6 +78,15 @@ jobs:
         PYOPENGL_PLATFORM=egl MUJOCO_GL=egl python3 -c """from tensordict import *"""
         cd ..
         
+        # 9. Set sanitize version
+        if [[ ${{ github.event_name }} == push && (${{ github.ref_type }} == tag || (${{ github.ref_type }} == branch && ${{ github.ref_name }} == release/*)) ]]; then
+          echo '::group::Enable version string sanitization'
+          # This environment variable just has to exist and must not be empty. The actual value is arbitrary.
+          # See docs/source/conf.py for details
+          export TENSORDICT_SANITIZE_VERSION_STR_IN_DOCS=1
+          echo '::endgroup::'
+        fi
+
         # 10. Build doc
         cd ./docs
         make docs

docs/source/conf.py

@@ -35,12 +35,15 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
-# The short X.Y version.
-version = "main (" + str(tensordict.__version__) + " )"
-# The full version, including alpha/beta/rc tags.
-# TODO: verify this works as expected
-release = "main"
+# version: The short X.Y version.
+# release: The full version, including alpha/beta/rc tags.
+if os.environ.get("TENSORDICT_SANITIZE_VERSION_STR_IN_DOCS", None):
+    # Turn 1.11.0aHASH into 1.11 (major.minor only)
+    version = release = ".".join(tensordict.__version__.split(".")[:2])
+    html_title = " ".join((project, version, "documentation"))
+else:
+    version = f"main ({tensordict.__version__})"
+    release = "main"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.