MkDocs Snakemake Rule
MkDocs Plugin used to extract rule information.
Installation
To use this plugin, install it with pip in the same environment as MkDocs:
pip install mkdocs-snakemake-rule-plugin
Config
Then add the following entry to the MkDocs config file:
plugins:
- snakemake-rule:
rule_folders:
- 'workflow/rules'
schemas:
- 'workflow/schemas/rules.schema.yaml'
Tag
format
Format of tags are:
#SNAKEMAKE_RULE_SOURCE__filename__rulename#: for source code extraction#SNAKEMAKE_RULE_TABLE__filename__rulename#: for table generation
Tab parts:
- first section identifies if rule source or table should be created
- filename is where the rule is stored, can be without '.skm'
- rulename is the rule that will be extract
Usage
Add tags to your target file and they will be replaced with rule source or tables
MkDocs Markdown example
# Rule information
## Source
#SNAKEMAKE_RULE_SOURCE__fastp__fastp_pe#
## Parameters
#SNAKEMAKE_RULE_TABLEE__fastp__fastp_pe#
1 maintainer
Release files for mkdocs-snakemake-rule-plugin 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocs_snakemake_rule_plugin-1.0.0.tar.gz | 20.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocs_snakemake_rule_plugin-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.4 kB
Release files / mkdocs_snakemake_rule_plugin-1.0.0.tar.gz
| Download URL | mkdocs_snakemake_rule_plugin-1.0.0.tar.gz |
|---|---|
| Size | 20.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ac04a87fbb310c38e1d1167aa7c0f51aecb5646b8daeafac491dca0e3fe5e820
|
|
BLAKE2b-256 checksum How to use checksums |
1515c4e128269152b100f6481af5813cc71ae816443b6bdbc48c56f9f95dfe93
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / mkdocs_snakemake_rule_plugin-1.0.0-py3-none-any.whl
| Download URL | mkdocs_snakemake_rule_plugin-1.0.0-py3-none-any.whl |
|---|---|
| Size | 18.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
395810a87391a15760dbbe0068ba205c8dbb5d474b8662d3afc8fdb351414930
|
|
BLAKE2b-256 checksum How to use checksums |
3bcffea26ea948e5f95dc255222cce664060b48e7e73f281982c1bc27577bbeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
