Feature #584 proofread

.github/workflows/documentation.yaml

@@ -12,6 +12,7 @@ on:
       - docs/**
   pull_request:
     types: [opened, reopened, synchronize]
+  workflow_dispatch:
 
 jobs:
   documentation:
@@ -21,11 +22,10 @@ jobs:
       - uses: actions/checkout@v6
       - uses: actions/setup-python@v6
         with:
-          python-version: '3.10'
+          python-version: '3.12'
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade python-dateutil requests sphinx \
-          sphinx-gallery matplotlib Pillow sphinx_rtd_theme
+          python -m pip install --upgrade python-dateutil requests matplotlib Pillow
           python -m pip install -r docs/requirements.txt
       - name: Build docs
         run: ./.github/jobs/build_documentation.sh   
@@ -40,3 +40,9 @@ jobs:
           name: documentation_warnings.log
           path: artifact/doc_warnings.log
           if-no-files-found: ignore
+      - name: Check links
+        uses: dtcenter/metplus-action-linkcheck@v1
+        with:
+          fail-on-broken-links: 'true'
+          upload-artifact: 'true'
+          install-package: 'true'

docs/Contributors_Guide/github_repository.rst

@@ -1,5 +1,5 @@
 *********************************************
-Organization of Code in the Github Repository
+Organization of Code in the GitHub Repository
 *********************************************
 
 The relevant plotting code resides in one of two directories

docs/Contributors_Guide/pull_request.rst

@@ -1,5 +1,5 @@
 ***********************
-Pull Requests in Github
+Pull Requests in GitHub
 ***********************
 
 Please refer to the `Open a Pull Request

docs/Contributors_Guide/tests_github_actions.rst

@@ -1,5 +1,5 @@
 ****************************************
-Generate Tests and Add to Github Actions
+Generate Tests and Add to GitHub Actions
 ****************************************
 
 Create a subdirectory under the *test* directory
@@ -11,9 +11,8 @@ Add sample data (see applicable information in the
 <https://metplus.readthedocs.io/projects/metplotpy/en/develop/Contributors_Guide/new_plot.html#adding-a-new-plot>`_
 section).
 
-Use the pytest framework to generate tests. For more information review
-this `pytest documentation <https://docs.pytest.org/en/7.2.x>`_ for
-more information.
+Use the pytest framework to generate tests. For more information, review
+this `pytest documentation <https://docs.pytest.org/en/7.2.x>`_.
 
 Add an entry for the test in the
 *.github/workflows/unit_tests.yaml* file.

docs/Contributors_Guide/third_party_packages.rst

@@ -1,5 +1,5 @@
 ***************************************************************
-Add Additional Third-Party Packages to the Github actions tests
+Add Additional Third-Party Packages to the GitHub Actions tests
 ***************************************************************
 
 If necessary, modify the **requirements.txt** file

docs/Contributors_Guide/user_doc.rst

@@ -1,6 +1,6 @@
-*********************
-Add User Documenation
-*********************
+**********************
+Add User Documentation
+**********************
 
 Documentation should be added in the *docs/Users_Guide* directory.
 
@@ -29,10 +29,10 @@ Add images.
 Review and check for errors in the automatically generated documentation.
 
   Once the documentation has been committed and pushed to GitHub,
-  GitHub actions will automatically create the online documentation. 
+  GitHub Actions will automatically create the online documentation. 
 
   Contributors will be able to view the run for the build of the documentation
-  in the GitHub actions section of the METplotpy repository, which will
+  in the GitHub Actions section of the METplotpy repository, which will
   be named with the text of the last commit message and the
   text “Documentation” underneath.  
 

docs/Users_Guide/bar.rst

@@ -8,7 +8,7 @@ A bar plot shows comparisons among discrete categories. One axis of the
 chart shows the specific categories being compared, while the other
 represents some measured value. The heights or lengths are proportional to
 the values that they represent. Bar plots are simple and flexible, unlike
-some other METview plot types. Rather than using prescribed statistics in
+some other METviewer plot types. Rather than using prescribed statistics in
 a specific way, the user can select both axes.
 
 Bar plots are distinct from histograms and the two are not interchangeable.
@@ -40,12 +40,12 @@ The data is text output from MET in columnar format.
 
 e.g.
 
-*/usr/path/to/METplotpy*  if the source code was cloned or forked from the Github repository
+*/usr/path/to/METplotpy*  if the source code was cloned or forked from the GitHub repository
 
 or
 
 */usr/path/to/METplotpy-x.y.z*  if the source code was downloaded as a zip or gzip'd tar file from the Release link of
-the Github repository.  The *x.y.z* is the release number.
+the GitHub repository.  The *x.y.z* is the release number.
 
 
 Configuration Files
@@ -62,7 +62,7 @@ required. The first is a default configuration file, **bar_defaults.yaml**,
 which is found in the
 *$METPLOTPY_BASE/metplotpy/plots/config* directory. All default
 configuration files are located in the
-*$METPLOTPY_BASE/metplotpy/plots/config* directory.  *$METPLOTPY_BASE* is base directory where the
+*$METPLOTPY_BASE/metplotpy/plots/config* directory.  *$METPLOTPY_BASE* is the base directory where the
 METplotpy source code has been saved.  **Default configuration files are
 automatically loaded by the plotting code and do not need to be explicitly
 specified when generating a plot**.
@@ -79,7 +79,7 @@ Default Configuration File
 --------------------------
 
 The following is the *mandatory*, **bar_defaults.yaml** configuration file,
-which serves as a good starting point for creating a line
+which serves as a good starting point for creating a bar
 plot as it represents the default values set in METviewer.
 
 **NOTE**: This default configuration file is automatically loaded by
@@ -126,7 +126,7 @@ For example:
 
 This is where */username/myworkspace/METplotpy* corresponds to $METPLOTPY_BASE and
 */username/working_dir* corresponds to $WORKING_DIR.  Make sure that the
-$WORKING_DIR directory that is specifed exists and has the appropriate
+$WORKING_DIR directory that is specified exists and has the appropriate
 read and write permissions.
 The path listed for *plot_filename* may be changed to the output directory
 of one’s choosing. If this is not set, then the *plot_filename* setting
@@ -143,7 +143,7 @@ the *points_path* setting.
 
 *points_path: '/dir_to_save_points1_file'*
 
-Replace the */dir_to_save_points1_file* to the same directory where
+Replace the */dir_to_save_points1_file* with the same directory where
 the **.points1** file is saved.
 If points_path is commented out (indicated by a '#' symbol in front of it),
 remove the '#' symbol to uncomment
@@ -155,7 +155,7 @@ file is desired.
 
 To save the log output to a file, uncomment the *log_filename* entry and specify the path and
 name of the log file.  Select a directory with the appropriate read and write
-privileges.  To modify the verbosity of logging than what is set in the default config
+privileges.  To modify the verbosity of logging from what is set in the default config
 file, uncomment the *log_level* entry and specify the log level  (debug and info are higher verbosity, warning and error
 are lower verbosity).
 
@@ -171,7 +171,7 @@ The **custom_bar.yaml** configuration file, in combination with the
 To generate the above bar plot, perform the following:
 
 * If using the conda environment,
-  verify the conda environment is running and has has the required
+  verify the conda environment is running and has the required
   Python packages outlined in the `requirements section
   <https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation.html#python-requirements>`_.
 
@@ -197,7 +197,7 @@ To generate the above bar plot, perform the following:
 * Enter the following command:
 
   .. code-block:: ini
-		
+
     python $METPLOTPY_BASE/metplotpy/plots/bar/bar.py $WORKING_DIR/custom_bar.yaml
 
 *  A **bar.png** output file will be created in the directory that was

docs/Users_Guide/box.rst

@@ -43,12 +43,12 @@ METplotpy repository, where the box plot tests are located:
 
 e.g.
 
-*/usr/path/to/METplotpy*  if the source code was cloned or forked from the Github repository
+*/usr/path/to/METplotpy*  if the source code was cloned or forked from the GitHub repository
 
 or
 
 */usr/path/to/METplotpy-x.y.z*  if the source code was downloaded as a zip or gzip'd tar file from the Release link of
-the Github repository.  The *x.y.z* is the release number.
+the GitHub repository.  The *x.y.z* is the release number.
 
 
 Configuration Files
@@ -83,7 +83,7 @@ Default Configuration File
 --------------------------
 
 The following is the *mandatory*, **box_defaults.yaml** configuration file,
-which serves as a good starting point for creating a line
+which serves as a good starting point for creating a box
 plot as it represents the default values set in METviewer.
 
 .. literalinclude:: ../../metplotpy/plots/config/box_defaults.yaml
@@ -103,7 +103,7 @@ Copy this custom config file from the directory where the source code was
 saved to the working directory:
 
 .. code-block:: ini
-		
+
   cp $METPLOTPY_BASE/test/box/custom_box.yaml $WORKING_DIR/custom_box.yaml
 
 Modify the *stat_input* setting in the
@@ -144,7 +144,7 @@ setting to True. Uncomment or add (if it doesn't exist) the
 *points_path: '/dir_to_save_points1_file'*
 
 
-Replace the **/dir_to_save_points1_file** to the same directory where
+Replace the **/dir_to_save_points1_file** with the same directory where
 the **.points1** file is saved.
 If *points_path* is commented out (indicated by a '#' symbol in front of it),
 remove the '#' symbol to uncomment the points_path so that it will be used
@@ -155,7 +155,7 @@ unless saving the intermediate **.points1** file is desired.
 
 To save the log output to a file, uncomment the *log_filename* entry and specify the path and
 name of the log file.  Select a directory with the appropriate read and write
-privileges.  To modify the verbosity of logging than what is set in the default config
+privileges.  To modify the verbosity of logging from what is set in the default config
 file, uncomment the *log_level* entry and specify the log level  (debug and info are higher verbosity, warning and error
 are lower verbosity).
 
@@ -191,7 +191,7 @@ files are located.  Set the *stat_input* to
 
 *plot_filename: $WORKING_DIR/output_plots/box_default.png*
 
-Where *$WORKING_DIR* is the working directory where where all the custom
+Where *$WORKING_DIR* is the working directory where all the custom
 configuration files are being saved. **NOTE**: If the *plot_filename*
 (output directory) is specified to a directory other than the
 *$WORKING_DIR/output_plots*, the user must have read and write permissions
@@ -253,7 +253,7 @@ Perform the following to generate the plots:
 
   .. image:: figure/box_default.png
 
-  To generate the above *"defaults"* plot (i.e using default configuration
+  To generate the above *"defaults"* plot (i.e. using default configuration
   settings), use the "minimal" custom configuration file, **minimal_box.yaml**.
 
 
@@ -265,4 +265,4 @@ Perform the following to generate the plots:
 
 * A **box_default.png** output file will be created in the
   directory specified in the *plot_filename* configuration setting in
-  the **box_minimal.yaml** config file.
+  the **minimal_box.yaml** config file.

docs/Users_Guide/contour.rst

@@ -34,12 +34,12 @@ repository:
 
 e.g.
 
-*/usr/path/to/METplotpy*  if the source code was cloned or forked from the Github repository
+*/usr/path/to/METplotpy*  if the source code was cloned or forked from the GitHub repository
 
 or
 
 */usr/path/to/METplotpy-x.y.z*  if the source code was downloaded as a zip or gzip'd tar file from the Release link of
-the Github repository.  The *x.y.z* is the release number.
+the GitHub repository.  The *x.y.z* is the release number.
 
 
 
@@ -51,7 +51,7 @@ input data is located and to set plot attributes. These plot attributes
 correspond to values that can be set via the METviewer tool. YAML is a
 recursive acronym for "YAML Ain't Markup Language" and according to
 `yaml.org <https://yaml.org>`_,
-it is a "human-friendly data serialization language. It is commonly used for
+it is a "human-friendly data serialization language". It is commonly used for
 configuration files and in applications where data is being stored or
 transmitted. Two configuration files are required. The first is a
 default configuration file, **contour_defaults.yaml**,
@@ -143,7 +143,7 @@ Uncomment or add (if it doesn't exist) the *points_path* setting:
 
 *points_path: '/dir_to_save_points1_file'*
 
-Replace the */dir_to_save_points1_file* to the same directory where the
+Replace the */dir_to_save_points1_file* with the same directory where the
 **.points1** file is saved.
 If *points_path* is commented out (indicated by a '#' symbol in front of it),
 remove the '#' symbol to uncomment
@@ -155,7 +155,7 @@ file unless saving the intermediate **.points1** file is desired.
 
 To save the log output to a file, uncomment the *log_filename* entry and specify the path and
 name of the log file.  Select a directory with the appropriate read and write
-privileges.  To modify the verbosity of logging than what is set in the default config
+privileges.  To modify the verbosity of logging from what is set in the default config
 file, uncomment the *log_level* entry and specify the log level  (debug and info are higher verbosity, warning and error
 are lower verbosity).
 
@@ -170,7 +170,7 @@ perform the following:
 
 
 *  If using the conda environment, verify the conda environment
-   is running and has has the required Python packages outlined in the
+   is running and has the required Python packages outlined in the
    `requirements section
    <https://metplus.readthedocs.io/projects/metplotpy/en/latest/Users_Guide/installation.html#python-requirements>`_.
 
@@ -180,13 +180,13 @@ perform the following:
   For the ksh environment:
 
   .. code-block:: ini
-		
+
     export METPLOTPY_BASE=$METPLOTPY_BASE
 
   For the csh environment:
 
   .. code-block:: ini
-		
+
     setenv METPLOTPY_BASE $METPLOTPY_BASE
 
   Recall that *$METPLOTPY_BASE* is the directory path indicating where the METplotpy source code was saved.

docs/Users_Guide/difficulty_index.rst

@@ -16,11 +16,11 @@ will not address here is undiagnosed systematic error, which adds uncertainty in
 The challenge is combining these factors into a continuous function that allows the user to assess relative risk.
 
 The code for calculating and plotting the difficulty index was developed by Bill Campbell and Liz Satterfield of the
-Navy Research Lab (NRL) and modified by NCAR.
+Naval Research Lab (NRL) and modified by NCAR.
 
 
 For more information on calculating the difficulty index, please refer to this METplus use case:
-`METviewer documentation
+`UserScript_fcstGEFS_Difficulty_Index use case
 <https://metplus.readthedocs.io/en/develop/generated/model_applications/medium_range/UserScript_fcstGEFS_Difficulty_Index.html#sphx-glr-generated-model-applications-medium-range-userscript-fcstgefs-difficulty-index-py>`_.
 
 Example
@@ -61,7 +61,7 @@ Configuration Files
 
 All the settings for the example difficulty index plot are incorporated in
 the mycolormaps.py and plot_difficulty_index.py code.  The example_difficulty_index.py script imports these modules to
-create six sample plots.  The location of where these plots are saved are determined by settings in the
+create six sample plots.  The location of where these plots are saved is determined by settings in the
 example_difficulty_index.yaml configuration file:
 
 .. literalinclude:: ../../test/difficulty_index/example_difficulty_index.yaml
@@ -100,7 +100,7 @@ Run from the Command Line
 To generate the sample difficulty index plots, perform the following:
 
 *  If using the conda environment, verify the conda environment
-   is running and has has the required Python packages outlined in the **Required Packages** section above.
+   is running and has the required Python packages outlined in the **Required Packages** section above.
 
 
 Where $METPLOTPY_BASE is the directory where you saved the METplotpy source code and $WORKING_DIR is the directory