fix imports to allow doc compile

desihub · Feb 28, 2024 · 81537e9 · 81537e9
1 parent f326728
commit 81537e9
Show file tree

Hide file tree

Showing 6 changed files with 293 additions and 223 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -74,28 +74,28 @@ jobs:
                 COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
               run: coveralls
 
-    # docs:
-    #     name: Doc test
-    #     runs-on: ${{ matrix.os }}
-    #     strategy:
-    #         fail-fast: false
-    #         matrix:
-    #             os: [ubuntu-latest]
-    #             python-version: ['3.10']
+    docs:
+        name: Doc test
+        runs-on: ${{ matrix.os }}
+        strategy:
+            fail-fast: false
+            matrix:
+                os: [ubuntu-latest]
+                python-version: ['3.10']
 
-    #     steps:
-    #         - name: Checkout code
-    #           uses: actions/checkout@v3
-    #           with:
-    #             fetch-depth: 0
-    #         - name: Set up Python ${{ matrix.python-version }}
-    #           uses: actions/setup-python@v4
-    #           with:
-    #             python-version: ${{ matrix.python-version }}
-    #         - name: Install Python dependencies
-    #           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
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v3
+              with:
+                fetch-depth: 0
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              with:
+                python-version: ${{ matrix.python-version }}
+            - name: Install Python dependencies
+              run: python -m pip install --upgrade pip setuptools wheel Sphinx sphinx-rtd-theme
+            - name: Test the documentation
+              run: sphinx-build -W --keep-going -b html doc doc/_build/html
 
     api:
         name: API doc completeness test

diff --git a/README.md b/README.md
@@ -92,8 +92,8 @@ Reading auxiliary files from other places or running a `gfa_reduce` checkout loc
 it would be recommended to run `gfa_reduce` using a checkout of this repository's code rather than the exact NERSC location given above, as code development may be taking place within that `/global/homes/a/ameisner/gfa_reduce/py` directory
 
 to obtain a checkout of the `gfa_reduce` code
-```
-  git clone https://github.com/desihub/gfa_reduce.git
+```bash
+git clone https://github.com/desihub/gfa_reduce.git
 ```
 `gfa_reduce` also runs on the DESI cluster computers at Kitt Peak, although no configuration example for doing so is provided here
 
@@ -166,62 +166,4 @@ such `gfa_reduce` invocations print out various logging information, such as war
 
 ## Change Log
 
-### 1.0.0 (2024-01-xx, unreleased)
-
-First version for NERSC-only GFA processing.
-
-### 0.30.0 (2024-01-09)
-
-Final reference tag before merging NERSC compatibility branch (PR [#18](https://github.com/desihub/gfa_reduce/pull/18)).
-
-### 0.27.0 (v0027, 2021-04-22)
-
-v0027 set of reductions; fixed FIBER_FRACFLUX bug
-
-### 0.26.0 (v0026, 2021-03-08)
-
-v0026 full SV1 reprocessing (guider frames, matched coadds, acquisition images), including FIBERFAC, _ELG and _BGS quantities
-
-### 0.22.0 (v0022, 2021-01-30)
-
-version used for SV1 reprocessing labeled v0022
-
-### 0.10.0 (20200530, 2020-05-30)
-
-before module rename
-
-### 0.8.0 (v0008, 2020-03-19)
-
-adapt to deal with a change to the raw guide cube image extension headers
-
-### 0.7.0 (v0007, 2020-03-08)
-
-changes to PSF-based FWHM fitting and handling of missing EXPTIME values
-
-### 0.5.2 (v0005.02, 2020-02-12)
-
-minor change to add another dummy extension to _catalog output
-
-### 0.5.1 (v0005.01, 2020-02-10)
-
-minor change to logging; same data model as v0005
-
-### 0.5.0 (v0005, 2020-02-09)
-
-version used for first attempt at full reprocessing of DESI GFA dataset
-
-### 0.4.0 (v0004, 2020-02-03)
-
-version used for v0004 processing of all gfa*.fits.fz images from start of commissioning through 20200201
-
-### 0.3.0 (v0003_on_target, 2020-01-30)
-
-used for initial batch of v0003 reductions for first week of on-target spectroscopy, 20200119-20200127
-
-### 0.2.0 (center, 2019-11-12)
-
-with Python implementation of center added
-
-### 0.1.0 (pre_gfa, 2019-09-09)
-
-saving what's here before the repo tranforms into a GFA reduction pipeline
+See `doc/changes.rst`.
diff --git a/doc/changes.rst b/doc/changes.rst
@@ -0,0 +1,82 @@
+==========
+Change Log
+==========
+
+1.0.0 (2024-01-xx, unreleased)
+------------------------------
+
+First version for NERSC-only GFA processing, with :command:`desiInstall` support (PR `#20`_).
+
+.. _`#20`: https://github.com/desihub/gfa_reduce/pull/20
+
+0.30.0 (2024-01-09)
+-------------------
+
+Final reference tag before merging NERSC compatibility branch (PR `#18`_).
+
+.. _`#18`: https://github.com/desihub/gfa_reduce/pull/18
+
+0.27.0 (v0027, 2021-04-22)
+--------------------------
+
+v0027 set of reductions; fixed FIBER_FRACFLUX bug
+
+0.26.0 (v0026, 2021-03-08)
+--------------------------
+
+v0026 full SV1 reprocessing (guider frames, matched coadds, acquisition images), including FIBERFAC, _ELG and _BGS quantities
+
+0.22.0 (v0022, 2021-01-30)
+--------------------------
+
+version used for SV1 reprocessing labeled v0022
+
+0.10.0 (20200530, 2020-05-30)
+-----------------------------
+
+before module rename
+
+0.8.0 (v0008, 2020-03-19)
+-------------------------
+
+adapt to deal with a change to the raw guide cube image extension headers
+
+0.7.0 (v0007, 2020-03-08)
+-------------------------
+
+changes to PSF-based FWHM fitting and handling of missing EXPTIME values
+
+0.5.2 (v0005.02, 2020-02-12)
+----------------------------
+
+minor change to add another dummy extension to ``_catalog`` output
+
+0.5.1 (v0005.01, 2020-02-10)
+----------------------------
+
+minor change to logging; same data model as v0005
+
+0.5.0 (v0005, 2020-02-09)
+-------------------------
+
+version used for first attempt at full reprocessing of DESI GFA dataset
+
+0.4.0 (v0004, 2020-02-03)
+-------------------------
+
+version used for v0004 processing of all ``gfa*.fits.fz`` images from start of commissioning through 20200201
+
+0.3.0 (v0003_on_target, 2020-01-30)
+-----------------------------------
+
+used for initial batch of v0003 reductions for first week of on-target spectroscopy, 20200119-20200127
+
+0.2.0 (center, 2019-11-12)
+--------------------------
+
+with Python implementation of center added
+
+0.1.0 (pre_gfa, 2019-09-09)
+---------------------------
+
+saving what's here before the repo tranforms into a GFA reduction pipeline