Feature 963 quick search (#981)

* Per #963, testing syntax * Per #963, testing syntax again after error * Per #963, testing string substitution * Per #963, trying dot dot slash * Per #963, found a relative path solution with dot dot slash, modified one line only * updating quick search from develop to working branch with dot dot slash * fixing typo * Per #963, removed replace directive since it is not being used * Per #963, testing change to Note section for keywords * Per #963, Testing return in note * Per #963, removed note section under keywords and moved down the png name. * Per #963, trying out various formatting options * Per #963, trying out various formatting options * Per #963, added additional keywords headers to get a better feel for what it would actually look like * Added numbers to keywords for easier referencing * Per #963, cleaned up examples and left with the formatting the team chose * Per #963, try out adding a code block around a sphinx_gallery_thumbnail_path to see if it disappears because remove_config_comments was already set to True in the conf.py file, but this only removes configuration comments from code blocks, not from text blocks. * Per #963, trying an additonal comment to eliminate sphinx_gallery_thumbnail_path * Per #963, removing additonal comment to eliminate sphinx_gallery_thumbnail_path because it got rid of the thumbnail image * Per #963, adding py to code-block to see if it eliminates sphinx_gallery_thumbnail_path * Per #963, removing the code-block because it does not get rid of sphinx_gallery_thumbnail_path * first attempt at note update without web links * updating keywords area * updating keywords area * updating keywords area * adding quick search link * fixing quick search link * updating keywords area * fixing typo * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * fixing typo * deleting empty spaces * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * updating keywords area * fixing typo * updating keywords area * updating keywords area * updating keywords area * updating keywords area * Changed ASCII2NC to ASCII2NCToolUseCase * Modified list of keywords * Fixed typo Co-authored-by: Julie.Prestopnik <[email protected]>
dtcenter · Jul 6, 2021 · eb08988 · eb08988
1 parent 7a00b6f
commit eb08988
Show file tree

Hide file tree

Showing 106 changed files with 1,049 additions and 401 deletions.
diff --git a/docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.py b/docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC.py
@@ -116,7 +116,12 @@
 # --------
 #
 # .. note::
-#    `ASCII2NCToolUseCase <https://dtcenter.github.io/METplus/search.html?q=ASCII2NCToolUseCase&check_keywords=yes&area=default>`_
+#
+#   * ASCII2NCToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-ASCII2NC.png'
 #
diff --git a/docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.py b/docs/use_cases/met_tool_wrapper/ASCII2NC/ASCII2NC_python_embedding.py
@@ -113,8 +113,14 @@
 # Keywords
 # --------
 #
+# .. note::
+#
+#   * ASCII2NCToolUseCase
+#   * PythonEmbeddingFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-ASCII2NC.png'
 #
-# .. note::
-#  `ASCII2NCToolUseCase <https://dtcenter.github.io/METplus/search.html?q=ASCII2NCToolUseCase&check_keywords=yes&area=default>`_,
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_
diff --git a/docs/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.py b/docs/use_cases/met_tool_wrapper/CyclonePlotter/CyclonePlotter.py
@@ -116,5 +116,11 @@
 # Keywords
 # --------
 #
-# .. note:: `CyclonePlotterUseCase <https://dtcenter.github.io/METplus/search.html?q=CyclonePlotterUseCase&check_keywords=yes&area=default>`_
-
+# .. note::
+#
+#   * CyclonePlotterUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
diff --git a/docs/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat.py b/docs/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat.py
@@ -140,10 +140,16 @@
 # --------
 #
 # .. note::
-#  `EnsembleStatToolUseCase <https://dtcenter.github.io/METplus/search.html?q=EnsembleStatToolUseCase&check_keywords=yes&area=default>`_,
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_,
-#  `EnsembleAppUseCase <https://dtcenter.github.io/METplus/search.html?q=EnsembleAppUseCase&check_keywords=yes&area=default>`_,
-#  `ProbabilityGenerationAppUseCase <https://dtcenter.github.io/METplus/search.html?q=ProbabilityGenerationAppUseCase&check_keywords=yes&area=default>`_
-#  `GRIBFileUseCase <https://dtcenter.github.io/METplus/search.html?q=GRIBFileUseCase&check_keywords=yes&area=default>`_,
+#
+#   * EnsembleStatToolUseCase
+#   * PythonEmbeddingFileUseCase
+#   * EnsembleAppUseCase
+#   * ProbabilityGenerationAppUseCase
+#   * GRIBFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-EnsembleStat.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat_python_embedding.py b/docs/use_cases/met_tool_wrapper/EnsembleStat/EnsembleStat_python_embedding.py
@@ -135,9 +135,15 @@
 # --------
 #
 # .. note::
-#  `EnsembleStatToolUseCase <https://dtcenter.github.io/METplus/search.html?q=EnsembleStatToolUseCase&check_keywords=yes&area=default>`_,
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_,
-#  `EnsembleAppUseCase <https://dtcenter.github.io/METplus/search.html?q=EnsembleAppUseCase&check_keywords=yes&area=default>`_,
-#  `ProbabilityGenerationAppUseCase <https://dtcenter.github.io/METplus/search.html?q=ProbabilityGenerationAppUseCase&check_keywords=yes&area=default>`_
+#
+#   * EnsembleStatToolUseCase
+#   * PythonEmbeddingFileUseCase
+#   * EnsembleAppUseCase
+#   * ProbabilityGenerationAppUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-EnsembleStat.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/Example/Example.py b/docs/use_cases/met_tool_wrapper/Example/Example.py
@@ -204,4 +204,9 @@
 # Keywords
 # --------
 #
-# .. note:: `ExampleToolUseCase <https://dtcenter.github.io/METplus/search.html?q=ExampleToolUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * ExampleToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
diff --git a/docs/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.py b/docs/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles.py
@@ -237,6 +237,15 @@
 # Keywords
 # --------
 #
-# .. note:: `RegridDataPlaneToolUseCase <https://dtcenter.github.io/METplus/develop/search.html?q=RegridDataPlaneToolUseCase&check_keywords=yes&area=default>`_, `GRIB2FileUseCase  <https://dtcenter.github.io/METplus/develop/search.html?q=GRIB2FileUseCase&check_keywords=yes&area=default>`_, `FeatureRelativeUseCase  <https://dtcenter.github.io/METplus/develop/search.html?q=FeatureRelativeUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * RegridDataPlaneToolUseCase
+#   * GRIB2FileUseCase
+#   * FeatureRelativeUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-ExtractTiles.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles_mtd.py b/docs/use_cases/met_tool_wrapper/ExtractTiles/ExtractTiles_mtd.py
@@ -117,6 +117,14 @@
 # Keywords
 # --------
 #
-#  RegridDataPlaneToolUseCase, GRIB2FileUseCase
+# .. note::
+#
+#   * RegridDataPlaneToolUseCase
+#   * GRIB2FileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-ExtractTiles.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.py b/docs/use_cases/met_tool_wrapper/GempakToCF/GempakToCF.py
@@ -127,9 +127,14 @@
 # --------
 #
 # .. note::
-#  `GempakToCFToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GempakToCFToolUseCase&check_keywords=yes&area=default>`_,
-#  `GEMPAKFileUseCase <https://dtcenter.github.io/METplus/search.html?q=GEMPAKFileUseCase&check_keywords=yes&area=default>`_,
-#  `NOAAHMTOrgUseCase <https://dtcenter.github.io/METplus/search.html?q=NOAAHMTOrgUseCase&check_keywords=yes&area=default>`_,
-#  `NOAAWPCOrgUseCase <https://dtcenter.github.io/METplus/search.html?q=NOAAWPCOrgUseCase&check_keywords=yes&area=default>`_
+#
+#   * GempakToCFToolUseCase
+#   * GEMPAKFileUseCase
+#   * NOAAHMTOrgUseCase
+#   * NOAAWPCOrgUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GempakToCF.png'
diff --git a/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.py b/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask.py
@@ -110,9 +110,13 @@
 # --------
 #
 # .. note::
-#    `GenVxMaskToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GenVxMaskToolUseCase&check_keywords=yes&area=default>`_,
-#    `GRIBFileUseCase  <https://dtcenter.github.io/METplus/search.html?q=GRIBFileUseCase&check_keywords=yes&area=default>`_
 #
-
+#   * GenVxMaskToolUseCase
+#   * GRIBFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GenVxMask.png'
-
+#
diff --git a/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.py b/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_multiple.py
@@ -110,8 +110,13 @@
 # --------
 #
 # .. note::
-#    `GenVxMaskToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GenVxMaskToolUseCase&check_keywords=yes&area=default>`_,
-#    `GRIBFileUseCase  <https://dtcenter.github.io/METplus/search.html?q=GRIBFileUseCase&check_keywords=yes&area=default>`_
 #
-
+#   * GenVxMaskToolUseCase
+#   * GRIBFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GenVxMask.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.py b/docs/use_cases/met_tool_wrapper/GenVxMask/GenVxMask_with_arguments.py
@@ -110,8 +110,13 @@
 # --------
 #
 # .. note::
-#    `GenVxMaskToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GenVxMaskToolUseCase&check_keywords=yes&area=default>`_,
-#    `GRIBFileUseCase  <https://dtcenter.github.io/METplus/search.html?q=GRIBFileUseCase&check_keywords=yes&area=default>`_
 #
-
+#   * GenVxMaskToolUseCase
+#   * GRIBFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GenVxMask.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GridDiag/GridDiag.py b/docs/use_cases/met_tool_wrapper/GridDiag/GridDiag.py
@@ -118,7 +118,12 @@
 #
 # .. note::
 #
-#  `GridDiagToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GridDiagToolUseCase&check_keywords=yes&area=default>`_, `RuntimeFreqUseCase <https://dtcenter.github.io/METplus/search.html?q=RuntimeFreqUseCase&check_keywords=yes&area=default>`_
+#   * GridDiagToolUseCase
+#   * RuntimeFreqUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
 #
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GridDiag.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GridStat/GridStat.py b/docs/use_cases/met_tool_wrapper/GridStat/GridStat.py
@@ -120,6 +120,13 @@
 # Keywords
 # --------
 #
-# .. note:: `GridStatToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GridStatToolUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * GridStatToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GridStat.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GridStat/GridStat_multiple_config_files.py b/docs/use_cases/met_tool_wrapper/GridStat/GridStat_multiple_config_files.py
@@ -148,7 +148,13 @@
 # --------
 #
 # .. note::
-#  `GridStatToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GridStatToolUseCase&check_keywords=yes&area=default>`_,
-#  `MultiConfUseCase <https://dtcenter.github.io/METplus/search.html?q=MultiConfUseCase&check_keywords=yes&area=default>`_
+#
+#   * GridStatToolUseCase
+#   * MultiConfUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GridStat.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/GridStat/GridStat_python_embedding.py b/docs/use_cases/met_tool_wrapper/GridStat/GridStat_python_embedding.py
@@ -126,7 +126,14 @@
 # Keywords
 # --------
 #
-# .. note:: `GridStatToolUseCase <https://dtcenter.github.io/METplus/search.html?q=GridStatToolUseCase&check_keywords=yes&area=default>`_
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * GridStatToolUseCase
+#   * PythonEmbeddingFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-GridStat.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/METdbLoad/METdbLoad.py b/docs/use_cases/met_tool_wrapper/METdbLoad/METdbLoad.py
@@ -111,6 +111,13 @@
 # Keywords
 # --------
 #
+# .. note::
+#
+#   * METdbLoadUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-METdbLoad.png'
 #
-# .. note:: `METdbLoadUseCase <https://dtcenter.github.io/METplus/search.html?q=METdbLoadUseCase&check_keywords=yes&area=default>`_
diff --git a/docs/use_cases/met_tool_wrapper/MODE/MODE.py b/docs/use_cases/met_tool_wrapper/MODE/MODE.py
@@ -122,6 +122,13 @@
 # Keywords
 # --------
 #
+# .. note::
+#
+#   * MODEToolUseCase
+#   * DiagnosticsUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-MODE.png'
 #
-# .. note:: `MODEToolUseCase <https://dtcenter.github.io/METplus/search.html?q=MODEToolUseCase&check_keywords=yes&area=default>`_, `DiagnosticsUseCase <https://dtcenter.github.io/METplus/search.html?q=DiagnosticsUseCase&check_keywords=yes&area=default>`_
diff --git a/docs/use_cases/met_tool_wrapper/MODE/MODE_python_embedding.py b/docs/use_cases/met_tool_wrapper/MODE/MODE_python_embedding.py
@@ -126,7 +126,14 @@
 # Keywords
 # --------
 #
-# .. note:: `MODEToolUseCase <https://dtcenter.github.io/METplus/search.html?q=MODEToolUseCase&check_keywords=yes&area=default>`_
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * MODEToolUseCase
+#   * PythonEmbeddingFileUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-MODE.png'
+#
diff --git a/docs/use_cases/met_tool_wrapper/MTD/MTD.py b/docs/use_cases/met_tool_wrapper/MTD/MTD.py
@@ -120,6 +120,14 @@
 # Keywords
 # --------
 #
+# .. note::
+#
+#   * MTDToolUseCase
+#   * DiagnosticsUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-MTD.png'
 #
-# .. note:: `MTDToolUseCase <https://dtcenter.github.io/METplus/search.html?q=MTDToolUseCase&check_keywords=yes&area=default>`_, `DiagnosticsUseCase <https://dtcenter.github.io/METplus/search.html?q=DiagnosticsUseCase&check_keywords=yes&area=default>`_
diff --git a/docs/use_cases/met_tool_wrapper/MTD/MTD_python_embedding.py b/docs/use_cases/met_tool_wrapper/MTD/MTD_python_embedding.py
@@ -129,8 +129,13 @@
 # --------
 #
 # .. note::
-#  `MTDToolUseCase <https://dtcenter.github.io/METplus/search.html?q=MTDToolUseCase&check_keywords=yes&area=default>`_,
-#  `PythonEmbeddingFileUseCase <https://dtcenter.github.io/METplus/search.html?q=PythonEmbeddingFileUseCase&check_keywords=yes&area=default>`_
-#  `DiagnosticsUseCase <https://dtcenter.github.io/METplus/search.html?q=DiagnosticsUseCase&check_keywords=yes&area=default>`_
+#
+#   * MTDToolUseCase
+#   * PythonEmbeddingFileUseCase
+#   * DiagnosticsUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-MTD.png'
diff --git a/docs/use_cases/met_tool_wrapper/PB2NC/PB2NC.py b/docs/use_cases/met_tool_wrapper/PB2NC/PB2NC.py
@@ -115,6 +115,12 @@
 # Keywords
 # --------
 #
-# .. note:: `PB2NCToolUseCase <https://dtcenter.github.io/METplus/search.html?q=PB2NCToolUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * PB2NCToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-PB2NC.png'
diff --git a/docs/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_add.py b/docs/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_add.py
@@ -110,6 +110,13 @@
 # Keywords
 # --------
 #
+# .. note::
+#
+#   * PCPCombineToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
+#
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-PCPCombine.png'
 #
-# .. note:: `PCPCombineToolUseCase <https://dtcenter.github.io/METplus/search.html?q=PCPCombineToolUseCase&check_keywords=yes&area=default>`_
diff --git a/docs/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_bucket.py b/docs/use_cases/met_tool_wrapper/PCPCombine/PCPCombine_bucket.py
@@ -110,6 +110,13 @@
 # Keywords
 # --------
 #
-# .. note:: `PCPCombineToolUseCase <https://dtcenter.github.io/METplus/search.html?q=PCPCombineToolUseCase&check_keywords=yes&area=default>`_
+# .. note::
+#
+#   * PCPCombineToolUseCase
+#
+#   Navigate to the :ref:`quick-search` page to discover other similar use cases.
+#
+#
 #
 # sphinx_gallery_thumbnail_path = '_static/met_tool_wrapper-PCPCombine.png'
+#