Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ on:
- docs/**
pull_request:
types: [opened, reopened, synchronize]
workflow_dispatch:

jobs:
documentation:
Expand All @@ -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
Expand All @@ -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'
19 changes: 0 additions & 19 deletions .github/workflows/linkcheck.yml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/Users_Guide/bar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/contour.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/eclv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,13 +187,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.
Expand Down
6 changes: 3 additions & 3 deletions docs/Users_Guide/histogram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -268,13 +268,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.
Expand All @@ -298,7 +298,7 @@ perform the following:
command using the **prob_hist.yaml** file:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/histogram/prob_hist.py $WORKING_DIR/prob_hist.yaml

.. image:: figure/prob_hist.png
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/histogram_2d.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,14 +211,14 @@ Perform the following:
* Clone the METplotpy repository from GitHub. First, make the directory:

.. code-block:: ini

mkdir $METPLOTPY_BASE

* *$METPLOTPY_BASE* is the directory where the source code is66TAW saved.
Enter the following:

.. code-block:: ini

cd $METPLOTPY_BASE
git clone https://github.com/dtcenter/METplotpy

Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ find the **setup.py** script.
From the command line run:

.. code-block:: ini

pip install -e .

Do NOT forget the ending period **'.'** This indicates the **setup.py**
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/line/custom_line.yaml $WORKING_DIR/custom_line.yaml


Expand Down Expand Up @@ -225,7 +225,7 @@ To generate the above plot using the **line_defaults.yaml** and
For the ksh environment:

.. code-block:: ini

export METPLOTPY_BASE=$METPLOTPY_BASE

For the csh environment:
Expand Down
8 changes: 4 additions & 4 deletions docs/Users_Guide/performance_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ a *plot_filename* in the **minimal_performance_diagram.yaml** file):
Copy this file to the working directory:

.. code-block:: ini

cp $METPLOTPY_BASE/test/performance_diagram/minimal_performance_diagram.yaml $WORKING_DIR/minimal_performance_diagram.yaml

Add the *stat_input* (input data) and *plot_filename*
Expand Down Expand Up @@ -245,13 +245,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

Replacing the $METPLOTPY_BASE with the directory where the
Expand All @@ -273,7 +273,7 @@ perform the following:
command using the **custom_performance_diagram.yaml** file:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/performance_diagram/performance_diagram.py $WORKING_DIR/custom_performance_diagram.yaml

.. image:: figure/performance_diagram_custom.png
Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/reliability_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Perform the following:
* Enter the following command:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/reliability_diagram/reliability.py $WORKING_DIR/custom_reliability_diagram.yaml

In this example, this custom config file changes the color of the boxes.
Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/roc_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ Perform the following:
* Enter the following command:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/roc_diagram/roc_diagram.py $WORKING_DIR/custom_roc_diagram.yaml

In this example, this custom config file changes the title and axis
Expand Down
4 changes: 2 additions & 2 deletions docs/Users_Guide/scatter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,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/scatter/test_scatter_mpr.yaml $WORKING_DIR/custom_scatter.yaml


Expand Down Expand Up @@ -208,7 +208,7 @@ To generate the above plot using the **scatter_defaults.yaml** and
For the ksh environment:

.. code-block:: ini

export METPLOTPY_BASE=$METPLOTPY_BASE

For the csh environment:
Expand Down
8 changes: 4 additions & 4 deletions docs/Users_Guide/taylor_diagram.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ a *plot_filename* in the **minimal_taylor_diagram.yaml** file):
Copy this file to the working directory:

.. code-block:: ini

cp $METPLOTPY_BASE/test/taylor_diagram/minimal_taylor_diagram.yaml $WORKING_DIR/minimal_taylor_diagram.yaml

If the *stat_input* and *plot_filename* settings (output file/plot path) are missing, add
Expand Down Expand Up @@ -226,13 +226,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

Replacing the $METPLOTPY_BASE with the directory where the
Expand All @@ -254,7 +254,7 @@ perform the following:
command (below) using the **taylor_diagram_custom.yaml** file:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/taylor_diagram/taylor_diagram.py $WORKING_DIR/taylor_diagram_custom.yaml


Expand Down
2 changes: 1 addition & 1 deletion docs/Users_Guide/tcmpr_plots.rst
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,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/tcmpr_plots/tcmpr_multi_plots.yaml $WORKING_DIR/tcmpr_multi_plots.yaml

Set up the custom configuration file:
Expand Down
8 changes: 4 additions & 4 deletions docs/Users_Guide/wind_rose.rst
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ a *plot_filename* in the **minimal_wind_rose.yaml** file):
Copy this file to the working directory:

.. code-block:: ini

cp $METPLOTPY_BASE/test/wind_rose/minimal_wind_rose.yaml $WORKING_DIR/minimal_wind_rose.yaml

Add the *stat_input* (input data) and *plot_filename*
Expand Down Expand Up @@ -249,13 +249,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

Replacing the $METPLOTPY_BASE with the directory where the
Expand All @@ -277,7 +277,7 @@ perform the following:
command using the **wind_rose_custom.yaml** file:

.. code-block:: ini

python $METPLOTPY_BASE/metplotpy/plots/wind_rose/wind_rose.py $WORKING_DIR/wind_rose_custom.yaml

.. image:: figure/wind_rose_custom.png
Expand Down
12 changes: 2 additions & 10 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -106,16 +106,8 @@
linkcheck_workers = 8

linkcheck_ignore = [
# add regex patterns for URLs that should be skipped, e.g.:
# r'https://dtcenter\.org/.*', # if this site blocks automated requests
# r'https://matplotlib\.org/.*', # occasionally rate-limits automated clients
# r'https://scitools\.org\.uk/cartopy/.*', # occasionally slow
r'https://doi\.org/.*', # DOI redirectors often 403 non-browser requests
# bmcnoldy.rsmas.miami.edu sends an incomplete SSL certificate chain
# (missing intermediate cert). Browsers work around this via AIA
# fetching; curl/Python do not. Confirmed 2026-07 via curl -v
# ("SSL certificate problem: unable to get local issuer certificate").
# Re-check periodically and remove once fixed server-side.
# incomplete TLS certificate chain that browsers tolerate but Python does not,
# and often unreachable; check by hand
r'https://bmcnoldy\.rsmas\.miami\.edu/.*',
]

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ whose verification libraries formed the basis of MET and
whose mathematical brilliance, passion for maps, grid projections, and
graphics enriched and inspired new capabilities.

To `Venita Hagerty <https://sites.gsl.noaa.gov/authors/365>`_,
To **Venita Hagerty**,
for her pivotal expertise, support, and attention to
detail that ensured the success of METdataio and METexpress.

Expand Down
8 changes: 4 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
sphinx-gallery==0.14.0
sphinx-gallery==0.19.0
sphinxcontrib-bibtex==2.6.1
sphinx==5.3.0
sphinx-design==0.3.0
sphinx_rtd_theme==1.3.0
sphinx==8.2.3
sphinx-design==0.6.1
sphinx-rtd-theme==3.0.1
Loading