Support versioned documentation with dynamic version reading (#20)

* Initial plan

* Add versioned documentation support

Co-authored-by: jason810496 <[email protected]>

* Add Python 3.9+ compatibility and error handling for version reading

Co-authored-by: jason810496 <[email protected]>

* Improve exception handling and version parsing robustness

Co-authored-by: jason810496 <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: jason810496 <[email protected]>

Author: Copilot

.readthedocs.yml

@@ -32,4 +32,6 @@ sphinx:
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
-    - requirements: doc/requirements.txt
+    - requirements: doc/requirements.txt
+    - method: pip
+      path: .

doc/conf.py

@@ -6,10 +6,27 @@
 import os
 import sys
 
+# Handle Python 3.9+ compatibility for tomllib
+try:
+    import tomllib
+except ModuleNotFoundError:
+    import tomli as tomllib
+
 # path setup
 sys.path.insert(0, os.path.abspath(".."))
 sys.path.insert(0, os.path.abspath("../pgmq_sqlalchemy"))
 
+# Read version from pyproject.toml
+_pyproject_path = os.path.join(os.path.dirname(__file__), "..", "pyproject.toml")
+try:
+    with open(_pyproject_path, "rb") as f:
+        _pyproject_data = tomllib.load(f)
+        _version = _pyproject_data["project"]["version"]
+except (FileNotFoundError, KeyError, OSError) as e:
+    # Fallback to a default version if pyproject.toml is missing or invalid
+    print(f"Warning: Could not read version from pyproject.toml: {e}")
+    _version = "0.0.0"
+
 extensions = [
     "sphinx_copybutton",
     "sphinx.ext.autodoc",
@@ -22,6 +39,13 @@
 project = "pgmq-sqlalchemy"
 copyright = f'2024-{time.strftime("%Y")}, the pgmq-sqlalchemy developers'
 
+# Version information
+# The short X.Y version
+_version_parts = _version.split(".")
+version = ".".join(_version_parts[:2]) if len(_version_parts) >= 2 else _version
+# The full version, including alpha/beta/rc tags
+release = _version
+
 source_suffix = {
     ".rst": "restructuredtext",
 }

doc/requirements.txt

@@ -1,4 +1,5 @@
 sphinx
 sphinx-rtd-theme
 sphinx-copybutton
-SQLAlchemy
+SQLAlchemy
+tomli; python_version < "3.11"