Skip to content

Commit 965256b

Browse files
tsutterleytsutterley
authored
docs: use argparse descriptions within sphinx documentation (#53)
1 parent 5a5a9f5 commit 965256b

102 files changed

Lines changed: 1781 additions & 1601 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/environment.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,10 @@ dependencies:
2222
- python>=3.6
2323
- python-dateutil
2424
- pyyaml
25-
- recommonmark
2625
- scipy
2726
- scikit-learn
2827
- sphinx
29-
- sphinx-markdown-tables
28+
- sphinx-argparse
3029
- sphinx_rtd_theme
3130
- texlive-core
3231
- zarr

‎doc/source/conf.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,7 @@
3737
"numpydoc",
3838
"sphinx.ext.graphviz",
3939
"sphinx.ext.viewcode",
40-
"recommonmark",
41-
"sphinx_markdown_tables"
40+
"sphinxarg.ext"
4241
]
4342

4443
# Add any paths that contain templates here, relative to this directory.
@@ -57,6 +56,7 @@
5756
numfig = True
5857
autodoc_member_order = 'bysource'
5958
numpydoc_show_class_members = False
59+
pygments_style = 'native'
6060

6161
# -- Options for HTML output -------------------------------------------------
6262

‎doc/source/index.rst‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,16 @@ Python tools for obtaining and working with elevation data from the NASA ICESat-
4141
:hidden:
4242
:caption: Utilities
4343

44-
user_guide/convert_ICESat2_format.md
45-
user_guide/copy_scf_ICESat2_files.md
46-
user_guide/nsidc_icesat2_associated.md
47-
user_guide/nsidc_icesat2_convert.md
48-
user_guide/nsidc_icesat2_dragann.md
49-
user_guide/nsidc_icesat2_sync.md
50-
user_guide/nsidc_icesat2_sync_s3.md
51-
user_guide/scp_ICESat2_files.md
52-
user_guide/scp_scf_ICESat2_files.md
53-
user_guide/symbolic_ICESat2_files.md
44+
user_guide/convert_ICESat2_format.rst
45+
user_guide/copy_scf_ICESat2_files.rst
46+
user_guide/nsidc_icesat2_associated.rst
47+
user_guide/nsidc_icesat2_convert.rst
48+
user_guide/nsidc_icesat2_dragann.rst
49+
user_guide/nsidc_icesat2_sync.rst
50+
user_guide/nsidc_icesat2_sync_s3.rst
51+
user_guide/scp_ICESat2_files.rst
52+
user_guide/scp_scf_ICESat2_files.rst
53+
user_guide/symbolic_ICESat2_files.rst
5454

5555
.. toctree::
5656
:maxdepth: 1
@@ -60,24 +60,24 @@ Python tools for obtaining and working with elevation data from the NASA ICESat-
6060
user_guide/interp_IB_response_ICESat2_ATL06.rst
6161
user_guide/interp_IB_response_ICESat2_ATL07.rst
6262
user_guide/interp_IB_response_ICESat2_ATL11.rst
63-
user_guide/interp_sea_level_ICESat2_ATL06.md
64-
user_guide/interp_sea_level_ICESat2_ATL07.md
65-
user_guide/interp_sea_level_ICESat2_ATL11.md
66-
user_guide/MPI_DEM_ICESat2_ATL03.md
67-
user_guide/MPI_DEM_ICESat2_ATL06.md
68-
user_guide/MPI_DEM_ICESat2_ATL11.md
69-
user_guide/MPI_ICESat2_ATL03.md
70-
user_guide/MPI_ICESat2_ATL03_histogram.md
71-
user_guide/MPI_reduce_ICESat2_ATL03_RGI.md
72-
user_guide/MPI_reduce_ICESat2_ATL06_drainages.md
73-
user_guide/MPI_reduce_ICESat2_ATL06_grounded.md
74-
user_guide/MPI_reduce_ICESat2_ATL06_ice_shelves.md
75-
user_guide/MPI_reduce_ICESat2_ATL06_RGI.md
76-
user_guide/MPI_reduce_ICESat2_ATL11_drainages.md
77-
user_guide/MPI_reduce_ICESat2_ATL11_grounded.md
78-
user_guide/MPI_reduce_ICESat2_ATL11_ice_shelves.md
79-
user_guide/MPI_reduce_ICESat2_ATL11_RGI.md
80-
user_guide/reduce_ICESat2_ATL06_raster.md
81-
user_guide/reduce_ICESat2_ATL07_raster.md
82-
user_guide/reduce_ICESat2_ATL10_raster.md
83-
user_guide/reduce_ICESat2_ATL11_raster.md
63+
user_guide/interp_sea_level_ICESat2_ATL06.rst
64+
user_guide/interp_sea_level_ICESat2_ATL07.rst
65+
user_guide/interp_sea_level_ICESat2_ATL11.rst
66+
user_guide/MPI_DEM_ICESat2_ATL03.rst
67+
user_guide/MPI_DEM_ICESat2_ATL06.rst
68+
user_guide/MPI_DEM_ICESat2_ATL11.rst
69+
user_guide/MPI_ICESat2_ATL03.rst
70+
user_guide/MPI_ICESat2_ATL03_histogram.rst
71+
user_guide/MPI_reduce_ICESat2_ATL03_RGI.rst
72+
user_guide/MPI_reduce_ICESat2_ATL06_drainages.rst
73+
user_guide/MPI_reduce_ICESat2_ATL06_grounded.rst
74+
user_guide/MPI_reduce_ICESat2_ATL06_ice_shelves.rst
75+
user_guide/MPI_reduce_ICESat2_ATL06_RGI.rst
76+
user_guide/MPI_reduce_ICESat2_ATL11_drainages.rst
77+
user_guide/MPI_reduce_ICESat2_ATL11_grounded.rst
78+
user_guide/MPI_reduce_ICESat2_ATL11_ice_shelves.rst
79+
user_guide/MPI_reduce_ICESat2_ATL11_RGI.rst
80+
user_guide/reduce_ICESat2_ATL06_raster.rst
81+
user_guide/reduce_ICESat2_ATL07_raster.rst
82+
user_guide/reduce_ICESat2_ATL10_raster.rst
83+
user_guide/reduce_ICESat2_ATL11_raster.rst

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL03.md‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL03.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
========================
2+
MPI_DEM_ICESat2_ATL03.py
3+
========================
4+
5+
- Determines which digital elevation model tiles to read for a given ATL03 file
6+
- Reads 3\ |times|\ 3 array of tiles for points within bounding box of central mosaic tile
7+
- Interpolates digital elevation model to locations of ICESat-2 ATL03 photon event locations
8+
9+
- ArcticDEM 2m digital elevation model tiles
10+
11+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/>`_
12+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/>`_
13+
14+
- REMA 8m digital elevation model tiles
15+
16+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/>`_
17+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/>`_
18+
19+
- GIMP 30m digital elevation model tiles
20+
21+
* `https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/ <https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/>`_
22+
23+
`Source code`__
24+
25+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/scripts/MPI_DEM_ICESat2_ATL03.py
26+
27+
Calling Sequence
28+
################
29+
30+
.. argparse::
31+
:filename: ../../scripts/MPI_DEM_ICESat2_ATL03.py
32+
:func: arguments
33+
:prog: MPI_DEM_ICESat2_ATL03.py
34+
:nodescription:
35+
:nodefault:
36+
37+
.. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL06.md‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL06.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
========================
2+
MPI_DEM_ICESat2_ATL06.py
3+
========================
4+
5+
- Determines which digital elevation model tiles to read for a given ATL06 file
6+
- Reads 3\ |times|\ 3 array of tiles for points within bounding box of central mosaic tile
7+
- Interpolates digital elevation model to locations of ICESat-2 ATL06 segments
8+
9+
- ArcticDEM 2m digital elevation model tiles
10+
11+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/>`_
12+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/>`_
13+
14+
- REMA 8m digital elevation model tiles
15+
16+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/>`_
17+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/>`_
18+
19+
- GIMP 30m digital elevation model tiles
20+
21+
* `https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/ <https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/>`_
22+
23+
24+
`Source code`__
25+
26+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/scripts/MPI_DEM_ICESat2_ATL06.py
27+
28+
Calling Sequence
29+
################
30+
31+
.. argparse::
32+
:filename: ../../scripts/MPI_DEM_ICESat2_ATL06.py
33+
:func: arguments
34+
:prog: MPI_DEM_ICESat2_ATL06.py
35+
:nodescription:
36+
:nodefault:
37+
38+
.. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL11.md‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎doc/source/user_guide/MPI_DEM_ICESat2_ATL11.rst‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
========================
2+
MPI_DEM_ICESat2_ATL11.py
3+
========================
4+
5+
- Determines which digital elevation model tiles to read for a given ATL11 file
6+
- Reads 3\ |times|\ 3 array of tiles for points within bounding box of central mosaic tile
7+
- Interpolates digital elevation model to locations of ICESat-2 ATL11 segments
8+
9+
- ArcticDEM 2m digital elevation model tiles
10+
11+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/mosaic/v3.0/>`_
12+
* `http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/ArcticDEM/indexes/>`_
13+
14+
- REMA 8m digital elevation model tiles
15+
16+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/mosaic/v1.1/>`_
17+
* `http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/ <http://data.pgc.umn.edu/elev/dem/setsm/REMA/indexes/>`_
18+
19+
- GIMP 30m digital elevation model tiles
20+
21+
* `https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/ <https://n5eil01u.ecs.nsidc.org/MEASURES/NSIDC-0645.001/>`_
22+
23+
`Source code`__
24+
25+
.. __: https://github.com/tsutterley/read-ICESat-2/blob/main/scripts/MPI_DEM_ICESat2_ATL11.py
26+
27+
Calling Sequence
28+
################
29+
30+
.. argparse::
31+
:filename: ../../scripts/MPI_DEM_ICESat2_ATL11.py
32+
:func: arguments
33+
:prog: MPI_DEM_ICESat2_ATL11.py
34+
:nodescription:
35+
:nodefault:
36+
37+
.. |times| unicode:: U+00D7 .. MULTIPLICATION SIGN

‎doc/source/user_guide/MPI_ICESat2_ATL03.md‎

Lines changed: 0 additions & 22 deletions
This file was deleted.

0 commit comments

Comments
 (0)