update documentation for generate references

tardis-sn · Aug 23, 2018 · 08bbc01 · 08bbc01
1 parent f6b02f3
commit 08bbc01
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/docs/workflow/development_workflow.rst b/docs/workflow/development_workflow.rst
@@ -15,6 +15,9 @@ to the Astropy team for designing it.
 
     git_workflow
     release_workflow
+
+.. toctree::
+
     update_refdata
 
 
diff --git a/docs/workflow/update_refdata.rst b/docs/workflow/update_refdata.rst
@@ -8,9 +8,15 @@ PR open.
 #. clone tardis-refdata (`git clone tardis-refdata`; you need to have git lfs installed) then make a new branch named
     the same as your new tardis feature branch.
 #. Generate new reference data (in your tardis directory and right branch) offline using
-    `python setup.py test --args="--tardis-refdata=<path to refdata repo/with the right branch> --generate-reference"`
+
+    .. code-block:: None
+
+        python setup.py test --args="--tardis-refdata=<path to refdata repo/with the right branch> --generate-reference"
+
 #. Rerun the tests and see if it does not fail using
-    `python setup.py test --args="--tardis-refdata=<path to refdata repo/with the right branch>"`
+
+    .. code-block:: None
+        python setup.py test --args="--tardis-refdata=<path to refdata repo/with the right branch>"
 #. Switch to tardis-refdata. Commit the changed ref-data and open a PR on tardis-refdata
 #. Make a copy of the refdata comparer notebook provided in TARDIS-refdata to check if there are
     any unexpected changes in the updated reference data and the previous reference data