[CI,Doc] Sanitize version (#2120)

Author: Vincent Moens

.github/workflows/docs.yml

@@ -73,15 +73,24 @@ jobs:
         
         # 8. Install requirements
         python3 -m pip install -r docs/requirements.txt --quiet --root-user-action=ignore
-        
-        # 9. Test torchrl installation
+
+        # 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 RL_SANITIZE_VERSION_STR_IN_DOCS=1
+          echo '::endgroup::'
+        fi
+
+        # 10. Test torchrl installation
         mkdir _tmp
         cd _tmp
         PYOPENGL_PLATFORM=egl MUJOCO_GL=egl python3 -c """from torchrl.envs.libs.dm_control import DMControlEnv
         print(DMControlEnv('cheetah', 'run', from_pixels=True).reset())"""
         cd ..
         
-        # 10. Build doc
+        # 11. Build doc
         cd ./docs
         # timeout 7m bash -ic "MUJOCO_GL=egl sphinx-build ./source _local_build" || code=$?; if [[ $code -ne 124 && $code -ne 0 ]]; then exit $code; fi
         # bash -ic "PYOPENGL_PLATFORM=egl MUJOCO_GL=egl sphinx-build ./source _local_build" || code=$?; if [[ $code -ne 124 && $code -ne 0 ]]; then exit $code; fi

docs/source/conf.py

@@ -39,12 +39,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(torchrl.__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("RL_SANITIZE_VERSION_STR_IN_DOCS", None):
+    # Turn 1.11.0aHASH into 1.11 (major.minor only)
+    version = release = ".".join(torchrl.__version__.split(".")[:2])
+    html_title = " ".join((project, version, "documentation"))
+else:
+    version = f"main ({torchrl.__version__})"
+    release = "main"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.