Merge pull request #200 from DendrouLab/preprocess_pipeline_yaml_doc

Preprocess pipeline yaml documentation
DendrouLab · Mar 6, 2024 · 1f0161f · 1f0161f
2 parents 0cb7826 + 5043714
commit 1f0161f
Show file tree

Hide file tree

Showing 4 changed files with 531 additions and 219 deletions.
diff --git a/docs/yaml_docs/index.rst b/docs/yaml_docs/index.rst
@@ -6,6 +6,7 @@ Workflows configuration files
 
     useful_info_on_yml
     pipeline_ingestion_yml
+    pipeline_preprocess_yml
     pipeline_integration_yml
     spatial_qc
     spatial_preprocess

diff --git a/docs/yaml_docs/pipeline_ingestion_yml.md b/docs/yaml_docs/pipeline_ingestion_yml.md
@@ -20,7 +20,7 @@ However, we do provide pre-filled versions of the `pipeline.yml` file for indivi
 For more information on functionalities implemented in `panpipes` to read the configuration files, such as reading blocks of parameters and reusing blocks with  `&anchors` and `*scalars`, please check [our documentation](./useful_info_on_yml.md)
 
 
-You can download the different ingestion pipeline.yml files here:
+You can download the different ingestion `pipeline.yml` files here:
 - Basic `pipeline.yml` file (not prefilled) that is generated when calling `panpipes ingest config: [Download here](https://github.com/DendrouLab/panpipes/blob/main/panpipes/panpipes/pipeline_ingest/pipeline.yml)
 - `pipeline.yml` file for [Ingesting data Tutorial](https://panpipes-tutorials.readthedocs.io/en/latest/ingesting_data/Ingesting_data_with_panpipes.html): [Download here](https://github.com/DendrouLab/panpipes-tutorials/blob/main/docs/ingesting_data/pipeline.yml)
 - `pipeline.yml` file for [Ingesting Mouse data Tutorial](https://panpipes-tutorials.readthedocs.io/en/latest/ingesting_mouse/Ingesting_mouse_data_with_panpipes.html): [Download here](https://github.com/DendrouLab/panpipes-tutorials/blob/main/docs/ingesting_mouse/pipeline.yml)