Add documentation stub for dicom_to_nifti.py (#166)

* Add documentation stub for dicom_to_nifti.py Resolves #165 **Why this change was necessary** `dicom_to_nifti.py` wasn't added to the `api.rst` document, but should be in there in the `misc` section. **What this change does** See title. **Any side-effects?** Re-compile docs locally to see it update locally. * Add src code formatting to CLI docstring
shimming-toolbox · Nov 16, 2020 · f9cd9c9 · f9cd9c9
1 parent 38c5f65
commit f9cd9c9
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/source/6_api_reference/api.rst b/docs/source/6_api_reference/api.rst
@@ -50,3 +50,6 @@ misc
 
 .. automodule:: shimmingtoolbox.cli.download_data
    :members:
+
+.. automodule:: shimmingtoolbox.cli.dicom_to_nifti
+   :members:
diff --git a/shimmingtoolbox/cli/dicom_to_nifti.py b/shimmingtoolbox/cli/dicom_to_nifti.py
@@ -21,7 +21,7 @@
 @click.option('-remove_tmp/-dont_remove_tmp', default=False,
               help="Specifies if tmp folder will be deleted after processing")
 def dicom_to_nifti_cli(path_dicoms, path_nifti, subject, fname_config, remove_tmp):
-    """Converts dicom files into nifti files by calling dcm2bids."""
+    """Converts dicom files into nifti files by calling ``dcm2bids``."""
 
     dicom_to_nifti(path_dicoms, path_nifti, subject_id=subject, path_config_dcm2bids=fname_config,
                    remove_tmp=remove_tmp)