add section about command line programs in the docs (#71)

* add section about command line programs * use autodoc_mock_imports
ubarsc · Oct 8, 2023 · e844fe5 · e844fe5
1 parent a62627b
commit e844fe5
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 14 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -16,17 +16,12 @@
 import sys
 import os
 
-# Set up 'mock' modules, needed to build docs if numpy, gdal etc., aren't installed
-import mock
-
 sys.path.insert(0, os.path.abspath('../..'))
 # for version info
 import rios          # noqa: E402
 
-MOCK_MODULES = ['numpy', 'osgeo', 'gdal', 'osgeo.gdal', 'cloudpickle',
+autodoc_mock_imports = ['numpy', 'osgeo', 'gdal', 'osgeo.gdal', 'cloudpickle',
                 'boto3']
-for mod_name in MOCK_MODULES:
-    sys.modules[mod_name] = mock.Mock()
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the

diff --git a/doc/source/environmentvars.rst b/doc/source/environmentvars.rst
@@ -71,15 +71,15 @@ RIOS honours the following environment variables which can be used to override d
 |                               | will be used instead. Added in RIOS   |                |                       |
 |                               | 1.4.5.                                |                |                       |
 +-------------------------------+---------------------------------------+----------------+-----------------------+
-|RIOS_AWSBATCH_STACK			| The CloudFormation stack name to use  | RIOS			 | Not in controls		 |
-|								| for AWS Batch jobs					|				 |						 | 
+|RIOS_AWSBATCH_STACK            | The CloudFormation stack name to use  | RIOS           | Not in controls       |
+|                               | for AWS Batch jobs                    |                |                       | 
 +-------------------------------+---------------------------------------+----------------+-----------------------+
-|RIOS_AWSBATCH_REGION			| The AWS Region to look for the 		| ap-southeast-2 | Not in controls		 |
-|								| CloudFormation stack specified by		| 				 |						 |
-|								| DFLT_BATCH_STACK.						|				 |						 |
+|RIOS_AWSBATCH_REGION           | The AWS Region to look for the        | ap-southeast-2 | Not in controls       |
+|                               | CloudFormation stack specified by     |                |                       |
+|                               | DFLT_BATCH_STACK.                     |                |                       |
 +-------------------------------+---------------------------------------+----------------+-----------------------+
 |RIOS_NOMSG_TIMEOUT             | For AWS Batch sub jobs. The number of | 1 hour         | Not in controls       |
-|								| seconds after the last received 		|				 |						 |
-|								| message before deciding the main 		|				 |						 |
-|								| has crashed and exiting the job.		|				 |						 |
+|                               | seconds after the last received       |                |                       |
+|                               | message before deciding the main      |                |                       |
+|                               | has crashed and exiting the job.      |                |                       |
 +-------------------------------+---------------------------------------+----------------+-----------------------+
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -81,6 +81,18 @@ Low level functions
     rios_rat
     rios_colortable
     rios_readerinfo
+
+
+Command Line Programs
+---------------------
+
+RIOS comes with two command line programs:
+  - `rioscalcstats` computes statistics and pyramid layers (overviews) on a file. 
+  - `riosprintstats` prints statistics information previously calculated on the file. 
+
+Refer to the helpstrings (run with `-h`) for usage of these programs. Note that 
+by default, RIOS calculates pyramid layers and statistics on a file.
+
 
 Utilities
 --------------------