bug: dynamically get the latest version from release instead of tag

Author: bobleesj

doc/source/conf.py

@@ -17,7 +17,7 @@
 import time
 from importlib.metadata import version
 from pathlib import Path
-
+import requests
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use Path().resolve() to make it absolute, like shown here.
@@ -68,6 +68,22 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 
+def _get_latest_release_from_github(org: str, repo_name: str) -> str:
+    """Get the highest version release (including prereleases) from GitHub repository."""
+    url = f"https://api.github.com/repos/{org}/{repo_name}/releases"
+    response = requests.get(url)
+    releases = response.json()
+    valid_releases = [release for release in releases if "tag_name" in release]
+    if not valid_releases:
+        return "No valid releases found"
+    latest_version_release = valid_releases[0]["tag_name"]
+    return latest_version_release
+
+# Get the latest release version from GitHub repository
+org = "diffpy"
+repo_name = "diffpy.utils"
+latest_verion_from_github = _get_latest_release_from_github(org, repo_name)
+
 fullversion = version(project)
 # The short X.Y version.
 version = "".join(fullversion.split(".post")[:1])

src/diffpy/utils/diffraction_objects.py

@@ -203,6 +203,7 @@ def __add__(self, other):
         Examples
         --------
         Add a scalar value to the yarray of a DiffractionObject instance:
+        >>> my_do = DiffractionObject(wavelength=2 * np.pi, xarray=np.array([30, 60]), yarray=np.array([1, 2]), xtype="tth")
         >>> new_do = my_do + 10.1
         >>> new_do = 10.1 + my_do
 

src/diffpy/utils/validators.py

@@ -23,7 +23,7 @@ def is_number(string):
     True
 
     >>> is_number("007")
-    True
+    False
 
     >>> is_number("five")
     False