add documentation for HPSS functions

NOAA-EMC · Apr 2, 2024 · c47a003 · c47a003
1 parent af941c8
commit c47a003
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -8,5 +8,7 @@ API
   timetools
   jinja
   logger
+  hsi
+  htar
 
 
diff --git a/docs/hsi.rst b/docs/hsi.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: wxflow.hsi
+
+.. autofunction:: hsi
+.. autofunction:: get
+.. autofunction:: put
+.. autofunction:: chmod
+.. autofunction:: chgrp
+.. autofunction:: rm
+.. autofunction:: mkdir
+.. autofunction:: ls
+.. autofunction:: exists
diff --git a/docs/htar.rst b/docs/htar.rst
@@ -0,0 +1,8 @@
+.. currentmodule:: wxflow.htar
+
+.. autofunction:: htar
+.. autofunction:: create
+.. autofunction:: extract
+.. autofunction:: xvf
+.. autofunction:: cvf
+.. autofunction:: tell
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,5 +8,7 @@ API @@
       timetools
       jinja
       logger
+      hsi
+      htar