Merge pull request #239 from FCP-INDI/update/cpac-wrapper-crash-command

📚 Add `cpac crash` command to documentation

Author: sgiavasis

docs/_sources/user/help.rst

@@ -8,8 +8,16 @@ If you find a bug, or would like to request a new feature please visit the `GitH
 If you have a question that is not answered in the User Guide or encounter an issue not covered in the `Common Issues and Solutions` section below, you should submit it to the `C-PAC user forum <https://groups.google.com/forum/#!forum/cpax_forum>`__.
 
 View Crash Files
-^^^^^^^^^^^^^^^^^^^
-If you run C-PAC through the container (Docker/Singularity), you need to enter the container by typing:
+^^^^^^^^^^^^^^^^
+If you have the :ref:`cpac Python package <cpac-python-package>`, you can simply run 
+
+.. code-block:: console
+
+    cpac crash /path/to/crash-file.pklz
+
+where :file:`/path/to/crash-file.pklz` is the path to the crash file you wish to view (with any necessary options, e.g., ``--image`` to specify a C-PAC image to use).
+
+Otherwise, you need to enter the container by typing:
 
 .. code-block:: console
 
@@ -23,7 +31,7 @@ Crash files are generated by Nipype, and can be viewed from the terminal by typi
     nipypecli crash crash-file.pklz
 
 
-Where :file:`crash-file.pklz` is the name of the crash file you wish to view.
+where :file:`crash-file.pklz` is the name of the crash file you wish to view.
 
 Common Issues
 ^^^^^^^^^^^^^

docs/_sources/user/quick.rst

@@ -3,6 +3,8 @@ C-PAC Quickstart
 
 .. include:: quick_overview.rst
 
+.. _cpac-python-package:
+
 .. include:: cpac.rst
 
 For instructions to run in Docker or Singularity without installing cpac (Python package), see :doc:`All Run Options </user/running>`