Using git submodule to display tutorial examples in docs (#567)

terrapower · Feb 8, 2022 · 75f65b2 · 75f65b2
1 parent f4610ba
commit 75f65b2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/tutorials/making_your_first_app.rst b/doc/tutorials/making_your_first_app.rst
@@ -8,7 +8,8 @@ Making your first ARMI-based App
 
 In this tutorial we will build a nuclear analysis application that runs (dummy) neutron
 flux and thermal/hydraulics calculations. Applications that do real analysis can be
-modeled after this starting point.
+modeled after this starting point. A complete, working version of this application can
+be found `here <https://github.com/terrapower/armi-example-app>`_.
 
 We'll assume you have the :doc:`ARMI Framework installed </user/user_install>` already.
 You can make sure it is ready by running the following command in a shell prompt::
@@ -47,6 +48,7 @@ files for us to fill in, like this::
             app.py
             plugin.py
             fluxSolver.py
+            materials.py
             thermalSolver.py
         doc/
         setup.py

diff --git a/tox.ini b/tox.ini
@@ -17,11 +17,15 @@ commands =
     pytest --ignore=armi/utils/tests/test_gridGui.py {posargs} armi
 
 [testenv:doc]
-whitelist_externals = /usr/bin/make
+whitelist_externals =
+    /usr/bin/git
+    /usr/bin/make
 deps=
     -r{toxinidir}/doc/requirements-docs.txt
 changedir = doc
 commands =
+    git submodule init
+    git submodule update
     make html
 
 [testenv:cov]