doc(modpathfile): clarify docstrings for get_destination_data() (#1171)

Reorganize MODFLOW 6 tutorials and rename a few.

Closes #1029

Author: jdhughes-dev

.docs/conf.py

@@ -181,8 +181,8 @@
 # html_static_path = ["_static"]
 
 html_theme_options = {
-    "github_url": "https://github.com/modflowpy/flopy",
-    "use_edit_page_button": False,
+    # "github_url": "https://github.com/modflowpy/flopy",
+    # "use_edit_page_button": False,
 }
 
 autosummary_generate = True
@@ -222,7 +222,7 @@
 html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 html_show_sphinx = True

.docs/create_rstfiles.py

@@ -1,8 +1,10 @@
 import os
 
 
-def create_section(f, title, filenames):
-    title = "{} Tutorials".format(title.upper())
+def create_section(f, title, filenames, upper_case=False):
+    if upper_case:
+        title = title.upper()
+    title = "{} Tutorials".format(title)
     line = "{}\n".format(title) + len(title) * "-" + "\n\n"
     line += "Contents:\n\n.. toctree::\n   :maxdepth: 2\n\n"
     for filename in filenames:
@@ -32,14 +34,24 @@ def create_tutorial_rst():
         create_section(f, "MODFLOW 6", tutorial_dict[key])
         keys.remove(key)
 
+    key = "modflow6data"
+    if key in keys:
+        create_section(f, "MODFLOW 6 FloPy Use", tutorial_dict[key])
+        keys.remove(key)
+
+    key = "modflow6output"
+    if key in keys:
+        create_section(f, "MODFLOW 6 Output", tutorial_dict[key])
+        keys.remove(key)
+
     key = "modflow"
     if key in keys:
         create_section(f, "MODFLOW", tutorial_dict[key])
         keys.remove(key)
 
     # create the remaining tutorial sections
     for key in keys:
-        create_section(f, key, tutorial_dict[key])
+        create_section(f, key, tutorial_dict[key], upper_case=True)
 
     # close the file
     f.close()

.docs/notebooks.rst

@@ -1,5 +1,9 @@
 Jupyter Notebooks
 =================
 
-A list of Jupyter Notebooks are available `here <https://github.com/modflowpy/flopy/blob/develop/docs/notebook_examples.md>`_.
-They are the best resource for learning the underlying capabilities in FloPy.
+A list of Jupyter Notebooks are available
+`here <https://github.com/modflowpy/flopy/blob/develop/docs/notebook_examples.md>`_.
+After the `tutorials <https://flopy.readthedocs.io/en/latest/tutorials.html>`_,
+the Jupyter Notebooks are the best resource for learning the underlying
+capabilities of FloPy.
+

.docs/tutorials.rst

@@ -10,15 +10,35 @@ Contents:
    :maxdepth: 2
 
    _notebooks/tutorial01_mf6
-   _notebooks/tutorial02_mf6
-   _notebooks/tutorial03_mf6
-   _notebooks/tutorial04_mf6
-   _notebooks/tutorial05_mf6
-   _notebooks/tutorial06_mf6
-   _notebooks/tutorial07_mf6
-   _notebooks/tutorial08_mf6
-   _notebooks/tutorial09_mf6
-   _notebooks/tutorial101_mf6_output
+
+
+MODFLOW 6 FloPy Use Tutorials
+-----------------------------
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   _notebooks/tutorial01_mf6_data
+   _notebooks/tutorial02_mf6_data
+   _notebooks/tutorial03_mf6_data
+   _notebooks/tutorial04_mf6_data
+   _notebooks/tutorial05_mf6_data
+   _notebooks/tutorial06_mf6_data
+   _notebooks/tutorial07_mf6_data
+   _notebooks/tutorial08_mf6_data
+
+
+MODFLOW 6 Output Tutorials
+--------------------------
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   _notebooks/tutorial01_mf6_output
 
 
 MODFLOW Tutorials

…les/Tutorials/modflow6/tutorial02_mf6.py …ials/modflow6data/tutorial01_mf6_data.pyexamples/Tutorials/modflow6/tutorial02_mf6.py renamed to examples/Tutorials/modflow6data/tutorial01_mf6_data.py examples/Tutorials/modflow6/tutorial02_mf6.py renamed to examples/Tutorials/modflow6data/tutorial01_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 2: Accessing Simulation Settings, Models, and Packages
+# # MODFLOW 6: Accessing Simulation Settings, Models, and Packages
 #
 # This tutorial shows how to view, access, and change the underlying package
 # variables for MODFLOW 6 objects in FloPy.  Interaction with a FloPy

…les/Tutorials/modflow6/tutorial03_mf6.py …ials/modflow6data/tutorial02_mf6_data.pyexamples/Tutorials/modflow6/tutorial03_mf6.py renamed to examples/Tutorials/modflow6data/tutorial02_mf6_data.py examples/Tutorials/modflow6/tutorial03_mf6.py renamed to examples/Tutorials/modflow6data/tutorial02_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 3: Observation packages
+# # MODFLOW 6: Observation packages
 #
 
 # ## Introduction to Observations

…les/Tutorials/modflow6/tutorial04_mf6.py …ials/modflow6data/tutorial03_mf6_data.pyexamples/Tutorials/modflow6/tutorial04_mf6.py renamed to examples/Tutorials/modflow6data/tutorial03_mf6_data.py examples/Tutorials/modflow6/tutorial04_mf6.py renamed to examples/Tutorials/modflow6data/tutorial03_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 4: Time Series Packages
+# # MODFLOW 6: Time Series Packages
 #
 
 # ## Introduction to Time Series

…les/Tutorials/modflow6/tutorial05_mf6.py …ials/modflow6data/tutorial04_mf6_data.pyexamples/Tutorials/modflow6/tutorial05_mf6.py renamed to examples/Tutorials/modflow6data/tutorial04_mf6_data.py examples/Tutorials/modflow6/tutorial05_mf6.py renamed to examples/Tutorials/modflow6data/tutorial04_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 5: Time Array Series Packages
+# # MODFLOW 6: Time Array Series Packages
 #
 
 # ## Introduction to Time Array Series

…les/Tutorials/modflow6/tutorial06_mf6.py …ials/modflow6data/tutorial05_mf6_data.pyexamples/Tutorials/modflow6/tutorial06_mf6.py renamed to examples/Tutorials/modflow6data/tutorial05_mf6_data.py examples/Tutorials/modflow6/tutorial06_mf6.py renamed to examples/Tutorials/modflow6data/tutorial05_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 6: Working with MODFLOW Scalar Data
+# # MODFLOW 6: Working with MODFLOW Scalar Data
 #
 # This tutorial shows how to view, access, and change the underlying data
 # variables for MODFLOW 6 objects in FloPy.  Interaction with a FloPy

…les/Tutorials/modflow6/tutorial07_mf6.py …ials/modflow6data/tutorial06_mf6_data.pyexamples/Tutorials/modflow6/tutorial07_mf6.py renamed to examples/Tutorials/modflow6data/tutorial06_mf6_data.py examples/Tutorials/modflow6/tutorial07_mf6.py renamed to examples/Tutorials/modflow6data/tutorial06_mf6_data.py

@@ -12,7 +12,7 @@
 #     name: python3
 # ---
 
-# # MODFLOW 6 Tutorial 7: Working with MODFLOW List Data.
+# # MODFLOW 6: Working with MODFLOW List Data.
 #
 # This tutorial shows how to view, access, and change the underlying data
 # variables for MODFLOW 6 objects in FloPy.  Interaction with a FloPy