Backport PR #313: Fix version rendering in docs (#314)

Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
wtbarnes · Sep 12, 2024 · 48046c9 · 48046c9
1 parent 8fe6ed6
commit 48046c9
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -5,6 +5,7 @@
 import datetime
 import os
 
+from packaging.version import Version
 from sphinx_gallery.sorting import ExplicitOrder
 
 # This file does only contain a selection of the most common options. For a
@@ -19,8 +20,13 @@
 
 from fiasco import __version__
 
-version = release = __version__
-is_development = '.dev' in __version__
+_version_ = Version(__version__)
+# NOTE: Avoid "post" appearing in version string in rendered docs
+if _version_.is_postrelease:
+    version = release = f'{_version_.major}.{_version_.minor}.{_version_.micro}'
+else:
+    version = release = str(_version_)
+is_development = _version_.is_devrelease
 
 # -- General configuration ---------------------------------------------------
 extensions = [

diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,7 @@
 fiasco Documentation
 ====================
 
-Welcome to the documentation for fiasco **version |release|**
+Welcome to the documentation for fiasco version |release|.
 
 fiasco provides a Python interface to the `CHIANTI atomic database`_.
 In addition to several high-level abstractions of the atomic data, fiasco also provides many common atomic physics calculations.