docs: use sphinx argparse v0.4.0 (#67)

* docs: use sphinx argparse v0.4.0

refactor: use f-strings for ascii and verbose output

* refactor: comment lines

* Update test_download_and_read.py

Author: tsutterley

.github/workflows/auto-update-files.yml

@@ -49,14 +49,14 @@ jobs:
       id: changes
       run: |
         if [ -n "$(git status --porcelain)" ] ; then
-            echo "::set-output name=detected::true";
+            echo "DETECTED=true" >> $GITHUB_OUTPUT;
             echo "::debug::Changes detected";
         else
-            echo "::set-output name=detected::false";
+            echo "DETECTED=false" >> $GITHUB_OUTPUT;
             echo "::debug::No changes detected";
         fi
     - name: Create pull request
-      if: steps.changes.outputs.detected == 'true'
+      if: steps.changes.outputs.DETECTED == 'true'
       uses: peter-evans/create-pull-request@v3
       with:
         assignees: ${{ github.actor }}

doc/environment.yml

@@ -27,11 +27,11 @@ dependencies:
   - scikit-learn
   - scp
   - sphinx
-  - sphinx-argparse
   - sphinx_rtd_theme
   - texlive-core
   - zarr
   - pip:
+    - sphinx-argparse>=0.4
     - git+https://github.com/tsutterley/yapc.git
     - ..
 

doc/source/api_reference/MPI_DEM_ICESat2_ATL03.rst

@@ -28,7 +28,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_DEM_ICESat2_ATL03.py
+    :filename: MPI_DEM_ICESat2_ATL03.py
     :func: arguments
     :prog: MPI_DEM_ICESat2_ATL03.py
     :nodescription:

doc/source/api_reference/MPI_DEM_ICESat2_ATL06.rst

@@ -29,7 +29,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_DEM_ICESat2_ATL06.py
+    :filename: MPI_DEM_ICESat2_ATL06.py
     :func: arguments
     :prog: MPI_DEM_ICESat2_ATL06.py
     :nodescription:

doc/source/api_reference/MPI_DEM_ICESat2_ATL11.rst

@@ -28,7 +28,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_DEM_ICESat2_ATL11.py
+    :filename: MPI_DEM_ICESat2_ATL11.py
     :func: arguments
     :prog: MPI_DEM_ICESat2_ATL11.py
     :nodescription:

doc/source/api_reference/MPI_ICESat2_ATL03.rst

@@ -16,7 +16,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_ICESat2_ATL03.py
+    :filename: MPI_ICESat2_ATL03.py
     :func: arguments
     :prog: MPI_ICESat2_ATL03.py
     :nodescription:

doc/source/api_reference/MPI_ICESat2_ATL03_histogram.rst

@@ -16,7 +16,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_ICESat2_ATL03_histogram.py
+    :filename: MPI_ICESat2_ATL03_histogram.py
     :func: arguments
     :prog: MPI_ICESat2_ATL03_histogram.py
     :nodescription:

doc/source/api_reference/MPI_reduce_ICESat2_ATL03_RGI.rst

@@ -12,7 +12,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_reduce_ICESat2_ATL03_RGI.py
+    :filename: MPI_reduce_ICESat2_ATL03_RGI.py
     :func: arguments
     :prog: MPI_reduce_ICESat2_ATL03_RGI.py
     :nodescription:

doc/source/api_reference/MPI_reduce_ICESat2_ATL06_RGI.rst

@@ -12,7 +12,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_reduce_ICESat2_ATL06_RGI.py
+    :filename: MPI_reduce_ICESat2_ATL06_RGI.py
     :func: arguments
     :prog: MPI_reduce_ICESat2_ATL06_RGI.py
     :nodescription:

doc/source/api_reference/MPI_reduce_ICESat2_ATL06_drainages.rst

@@ -12,7 +12,7 @@ Calling Sequence
 ################
 
 .. argparse::
-    :filename: ../../scripts/MPI_reduce_ICESat2_ATL06_drainages.py
+    :filename: MPI_reduce_ICESat2_ATL06_drainages.py
     :func: arguments
     :prog: MPI_reduce_ICESat2_ATL06_drainages.py
     :nodescription: