Merge pull request #220 from punch-mission/add-rtd

Create .readthedocs.yaml

Author: jmbhughes

.github/workflows/docs.yml

@@ -0,0 +1,33 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - method: pip
+      extra_requirements:
+        - all
+        - docs
+      path: .

.readthedocs.yaml

@@ -7,14 +7,15 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 import os
 import sys
+from importlib.metadata import version as get_version
 
 sys.path.insert(0, os.path.abspath("../.."))
 
 
 project = "regularizepsf"
 copyright = "2023, J. Marcus Hughes and the PUNCH Science Operations Center"
 author = "J. Marcus Hughes and the PUNCH Science Operations Center"
-release = "0.4.0"
+release: str = get_version("regularizepsf")
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/conf.py

@@ -1,13 +1,13 @@
 [build-system]
-requires = ["setuptools", "wheel", "numpy", "Cython>=0.29.21"]
+requires = ["setuptools", "wheel", "numpy", "Cython>=0.29.21", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools]
 packages = ["regularizepsf"]
 
 [project]
 name = "regularizepsf"
-version = "0.4.1"
+dynamic = ["version"]
 requires-python = ">3.10"
 description = "Point spread function modeling and regularization"
 dependencies = [
@@ -40,9 +40,9 @@ docs = [
     "pydata-sphinx-theme",
     "sphinx-autoapi"
 ]
-
 dev = ["regularizepsf[test, docs]", "pre-commit"]
 
+[tool.setuptools_scm]
 
 [tool.ruff]
 exclude = ['tests/*']