Merge branch 'update-fre-cmor-doc3' into update-fre-cmor-doc2

NOAA-GFDL · Nov 7, 2024 · 05052d0 · 05052d0
2 parents 51a94d4 + f960776
commit 05052d0
Show file tree

Hide file tree

Showing 12 changed files with 57 additions and 35 deletions.
diff --git a/docs/badges.rst b/docs/badges.rst
@@ -1,3 +1,4 @@
+.. this file is explicitly for the hyperlinkage in the base README.md to the badge image files
 ======
 Badges
 ======

diff --git a/docs/contributing_to_doc.rst b/docs/contributing_to_doc.rst
@@ -1,3 +1,5 @@
+.. last updated early Nov 2024.
+   could use some refinement
 ===========================
 Documentation-Documentation
 ===========================

diff --git a/docs/developer_usage.rst b/docs/developer_usage.rst
@@ -1,3 +1,4 @@
+.. NEEDS UPDATING #TODO
 ===============
 Developer Usage
 ===============

diff --git a/docs/fre_app.rst b/docs/fre_app.rst
@@ -1,2 +1,6 @@
-1. ``generate-time-averages``
-2. ``regrid_xy``
+.. NEEDS UPDATING #TODO
+``generate-time-averages``
+--------------------------
+
+``regrid_xy``
+-------------
diff --git a/docs/fre_catalog.rst b/docs/fre_catalog.rst
@@ -1,8 +1,12 @@
-1. ``builder`` Generate a catalog
-
+.. NEEDS UPDATING #TODO
+``builder``
+-----------
+ Generate a catalog
 * Builds json and csv format catalogs from user input directory path
 * Minimal Syntax: ``fre catalog builder -i [input path] -o [output path]``
 * Module(s) needed: n/a
 * Example: ``fre catalog builder -i /archive/am5/am5/am5f3b1r0/c96L65_am5f3b1r0_pdclim1850F/gfdl.ncrc5-deploy-prod-openmp/pp -o ~/output --overwrite``
 
-2. ``validate`` Validate the catalog
+``validate``
+------------
+Validate the catalog
diff --git a/docs/fre_cmor.rst b/docs/fre_cmor.rst
@@ -1,3 +1,5 @@
-1. ``run``
+.. last updated Nov 2024
+``run``
+-------   
 
 
diff --git a/docs/fre_make.rst b/docs/fre_make.rst
@@ -1,3 +1,4 @@
+.. NEEDS UPDATING #TODO
 1. ``run-fremake``
 
 * placehold
diff --git a/docs/fre_pp.rst b/docs/fre_pp.rst
@@ -1,11 +1,14 @@
-1. ``configure`` 
+.. NEEDS UPDATING #TODO
+``configure``
+-------------
 
 * Postprocessing yaml configuration
 * Minimal Syntax: ``fre pp configure -y [user-edit yaml file]``
 * Module(s) needed: n/a
 * Example: ``fre pp configure -y /home/$user/pp/ue2/user-edits/edits.yaml``
 
-2. ``checkout``
+``checkout``
+------------
 
 * Checkout template file and clone gitlab.gfdl.noaa.gov/fre2/workflows/postprocessing.git repository
 * Minimal Syntax: ``fre pp checkout -e [experiment name] -p [platform name] -t [target name]``

diff --git a/docs/fre_yamltools.rst b/docs/fre_yamltools.rst
@@ -1,3 +1,6 @@
-1. ``combine-yamls``
+.. NEEDS UPDATING #TODO
+   
+``combine-yamls``
+-----------------
 
 * placehold
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,8 @@
 Welcome to Fre-Cli's documentation!
 ===================================
 
+.. the entry in the toc must be the .rst filename.
+   what shows in the webpage is the first header or title
 .. toctree::
    :maxdepth: 3
    :caption: Contents:

diff --git a/docs/setup.rst b/docs/setup.rst
@@ -1,3 +1,4 @@
+.. NEEDS UPDATING #TODO
 =====
 Setup
 =====

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -1,12 +1,13 @@
-=====
-Usage
-=====
+.. NEEDS UPDATING #TODO
+=============
+Usage-By-Tool
+=============
 
 for setup, see the setup section.
 
 
-Calling ``fre``
-===============
+``fre``
+=======
 
 Brief rundown of commands also provided below:
 
@@ -23,65 +24,62 @@ Brief rundown of commands also provided below:
   *entry point*. Without it, the call would be instead, something like ``python fre/fre.py``
 
 
-Usage-By-Tool
-=============
-
-
 ``fre app``
------------
+===========
 
 .. include:: fre_app.rst
 
 
 ``fre catalog``
----------------
+===============
 
 .. include:: fre_catalog.rst
 
 
 ``fre cmor``
-------------
+============
 
 .. include:: fre_cmor.rst
 
 
 ``fre make``
-------------
+============
 
 .. include:: fre_make.rst
 
 
 ``fre pp``
-----------
+==========
 
 .. include:: fre_pp.rst
 
 
 ``fre yamltools``
------------------
+=================
 
 .. include:: fre_yamltools.rst
 
 
-Tools Not-Yet-Implemented
-=========================
-
 ``fre check``
--------------
+=============
+
+**not-yet-implemented**
 
-to-do
 
 ``fre list``
-------------
+============
+
+**not-yet-implemented**
 
-to-do
 
 ``fre run``
------------
+===========
+
+**not-yet-implemented**
 
-to-do
 
 ``fre test``
-------------
+============
+
+**not-yet-implemented**
 
-to-do