Skip to main content

A Sphinx extension for Snakemake

Project description

https://smutch.github.io/snakedoc/_images/snakedoc-logo.svg

A Sphinx extension for Snakemake workflows.

tests status coverage statistic pre-commit.ci status git3moji Formatted with black Imports formatted with isort

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.

Where to go from here

  • See the installation page how to install Snakedoc.

  • To get started, check out the guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

snakedoc-0.2.2.tar.gz (24.5 kB view hashes)

Uploaded Source

Built Distribution

snakedoc-0.2.2-py3-none-any.whl (12.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page