UW-667 Jupyter notebook: Config Tool Part I (#607)

* WIP * WIP * WIP * Add config notebook, unit tests, Binder link & button * add newline * add markdown comment * add suggestions from review * apply suggestion from review * updating markdown comments and RtD links * Apply suggestions from code review Co-authored-by: Paul Madden <[email protected]> * change error demo style and update section links * Apply suggestions from review * update testing * update RtD links and add uwtools version --------- Co-authored-by: Paul Madden <[email protected]>
ufs-community · Sep 25, 2024 · 3561964 · 3561964
1 parent c6d6040
commit 3561964
Show file tree

Hide file tree

Showing 8 changed files with 1,086 additions and 2 deletions.
diff --git a/docs/sections/user_guide/api/config.rst b/docs/sections/user_guide/api/config.rst
@@ -1,6 +1,9 @@
 ``uwtools.api.config``
 ======================
 
+.. image:: https://mybinder.org/badge_logo.svg
+   :target: https://mybinder.org/v2/gh/ufs-community/uwtools/notebooks?labpath=notebooks%2Fconfig.ipynb
+
 .. automodule:: uwtools.api.config
    :inherited-members: UserDict
    :members:
diff --git a/docs/sections/user_guide/index.rst b/docs/sections/user_guide/index.rst
@@ -23,8 +23,9 @@ User Guide
    <ul>
    <li>API Jupyter Notebooks
       <ul>
-         <li><a href="https://mybinder.org/v2/gh/ufs-community/uwtools/notebooks?labpath=notebooks%2Ftemplate.ipynb">Template Tool</a>
+         <li><a href="https://mybinder.org/v2/gh/ufs-community/uwtools/notebooks?labpath=notebooks%2Fconfig.ipynb">Config Tool</a>
          <li><a href="https://mybinder.org/v2/gh/ufs-community/uwtools/notebooks?labpath=notebooks%2Ffs.ipynb">File System Tool</a>
+         <li><a href="https://mybinder.org/v2/gh/ufs-community/uwtools/notebooks?labpath=notebooks%2Ftemplate.ipynb">Template Tool</a>
       </ul>
    </ul>