Skip to content

An example of running through the entire Snakemake workflow #30

Open
@adam2392

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

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions