rbturnbull / orthoflow

Orthoflow is a workflow for phylogenetic inference of genome-scale datasets of protein-coding genes.
https://rbturnbull.github.io/orthoflow/
Apache License 2.0
10 stars 2 forks source link

sphinx plugin for reading docstrings #9

Closed rbturnbull closed 2 years ago

rbturnbull commented 2 years ago

The snakemake parser has something which might read docstrings for rules but we need to look into this more.

smutch commented 2 years ago

Here is 95% of a complete Sphinx extension for documenting Snakemake workflows. I still need to document the extension (how meta!), add some more tests, and set up the CI. Any thoughts, advice, or suggestions are more than welcome!

Here is an example of the type of Sphinx rst file you can write with the extension.