mehmetpek / snakedoc Goto Github PK

A Sphinx extension for Snakemake workflows.

Snakemake workflows can be complicated and difficult to follow, especially for new users. Having good documentation explaining what each rule is doing, what assumptions are being made, and what parts can be configured are important for understandable and reusable workflows. Snakedoc aims to help with this by:

1. encouraging developers to write contextual and useful docstrings, inline with their rules; and
2. providing a way to automatically scrape those docstrings and present them in Sphinx documentation where they can be further augmented as needed.

• See the installation page how to install Snakedoc.
• To get started, check out the guide.