Merge pull request #201 from desihub/migrate-units

Migrate unit validation to desiutil; support adding units to FITS files.
desihub · Sep 27, 2023 · 93aca73 · 93aca73
2 parents 681277b + 66b3c72
commit 93aca73
Show file tree

Hide file tree

Showing 6 changed files with 417 additions and 75 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -89,7 +89,7 @@ jobs:
               with:
                 python-version: ${{ matrix.python-version }}
             - name: Install Python dependencies
-              run: python -m pip install --upgrade pip setuptools wheel Sphinx sphinx-rtd-theme
+              run: python -m pip install --upgrade pip setuptools wheel Sphinx\<7 sphinx-rtd-theme
             - name: Test the documentation
               run: sphinx-build -W --keep-going -b html doc doc/_build/html
 

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -5,16 +5,20 @@
 # Required
 version: 2
 
+build:
+    os: "ubuntu-22.04"
+    tools:
+        python: "3.10"
+
 # Build documentation in the doc/ directory with Sphinx
 sphinx:
     configuration: doc/conf.py
-    fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF and ePub
-formats: all
+# formats: all
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-    version: "3.8"
     install:
-      - requirements: doc/rtd-requirements.txt
+        - requirements: doc/rtd-requirements.txt
+
diff --git a/doc/api.rst b/doc/api.rst
@@ -8,8 +8,8 @@ desiutil API
 .. automodule:: desiutil.annotate
     :members:
 
-.. .. automodule:: desiutil.api
-..     :members:
+.. automodule:: desiutil.api
+    :members:
 
 .. automodule:: desiutil.bitmask
     :members:
@@ -53,8 +53,8 @@ desiutil API
 .. automodule:: desiutil.redirect
     :members:
 
-.. .. automodule:: desiutil.setup
-..     :members:
+.. automodule:: desiutil.setup
+    :members:
 
 .. automodule:: desiutil.sklearn
     :members:

diff --git a/doc/changes.rst b/doc/changes.rst
@@ -9,6 +9,14 @@ Change Log
 
 * Remove deprecated commands in :mod:`desiutil.setup`.
 * Remove deprecated module :mod:`desiutil.census`.
+* Remove deprecated top-level ``setup.py``.
+
+3.4.2 (unreleased)
+------------------
+
+* Fully support adding units and comments to FITS table columns (PR `#201`).
+
+.. _`#201`: https://github.com/desihub/desiutil/pull/201
 
 3.4.1 (2023-09-25)
 ------------------