MkDocs Plugin used to extrace rule information, to generate code and tables.
Project description
MkDocs Snakemake Rule
MkDocs Plugin used to extract rule information.
To use this plugin, install it with pip in the same environment as MkDocs:
pip install mkdocs-snakemake-rule-plugin
Then add the following entry to the MkDocs config file:
plugins:
- snakemake-rule:
rule_folders:
- 'workflow/rules'
In your target file, add a tag to be replaced with format
SNAKEMAKE_RULE_SOURCE__filename__rulename
- filename is where the rule is stored, can be without '.skm'
- rulename is the rule that will be extract
#SNAKEMAKE_RULE_SOURCE__fastp__fastp_pe#
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Close
Hashes for mkdocs-snakemake-rule-plugin-0.1.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 375091c0f5a34dc7c64b3a5240596d9597fe804611c693c92531b00b129d10e9 |
|
| MD5 | 3644c8b277c642cf15b5fc794954c62d |
|
| BLAKE2b-256 | eb7d04b577e4376d588a44f4a5f36d130d6457b4cfcd11216fe29c5528685eb9 |
