-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed
Description
Describe the problem
To provide documentation on how the entire workflow runs to go from .dcms to the output BIDS files and visualization engine, an example file is needed with screenshots where applicable.
Describe your solution
An example_workflow.rst file that sits in docs/ that walks through w/ an open-source set of dicoms.
Describe possible alternatives
Alternatively, rules.rst file that autodocs the Snakemake rule docstrings (idk how to do this though).
Additional context
See https://github.com/sequana/sequana which has some nice sphinx-gneerated docs from the snakemake rules. We can try to borrow the sphinx-ext code there.
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or requestgood first issueGood for newcomersGood for newcomershelp wantedExtra attention is neededExtra attention is needed