# 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:
```yml
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#
```
Raw data
{
"_id": null,
"home_page": "https://github.com/smeds/mkdocs-snakemake-rule-plugin",
"name": "mkdocs-snakemake-rule-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8, <4",
"maintainer_email": "",
"keywords": "mkdocs,plugin,yaml,schema",
"author": "Patrik Smeds",
"author_email": "patrik.smeds@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c9/bb/62e8520a5fc2bd478b9768faa5ec6111831cfba601d3e1204878e415564a/mkdocs-snakemake-rule-plugin-0.4.0.tar.gz",
"platform": null,
"description": "# MkDocs Snakemake Rule\n\nMkDocs Plugin used to extract rule information.\n\n## Installation\n\nTo use this plugin, install it with pip in the same environment as MkDocs:\n\n```\npip install mkdocs-snakemake-rule-plugin\n```\n\n## Config\n\nThen add the following entry to the MkDocs config file:\n\n```yml\nplugins:\n - snakemake-rule:\n rule_folders:\n - 'workflow/rules'\n schemas:\n - 'workflow/schemas/rules.schema.yaml'\n```\n\n## Tag \n\n### format\n\nFormat of tags are:\n- `#SNAKEMAKE_RULE_SOURCE__filename__rulename#` : for source code extraction\n- `#SNAKEMAKE_RULE_TABLE__filename__rulename#` : for table generation\n\nTab parts:\n- first section identifies if rule source or table should be created\n- filename is where the rule is stored, can be without '.skm'\n- rulename is the rule that will be extract\n\n\n### Usage\n\nAdd tags to your target file and they will be replaced with rule source or tables\n\nMkDocs Markdown example\n```\n# Rule information\n## Source \n#SNAKEMAKE_RULE_SOURCE__fastp__fastp_pe#\n\n## Parameters\n#SNAKEMAKE_RULE_TABLEE__fastp__fastp_pe#\n\n```\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "MkDocs Plugin used to extrace rule information, to generate code and tables.",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/smeds/mkdocs-snakemake-rule-plugin"
},
"split_keywords": [
"mkdocs",
"plugin",
"yaml",
"schema"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c9bb62e8520a5fc2bd478b9768faa5ec6111831cfba601d3e1204878e415564a",
"md5": "7c95b21a248bb5786c92870122fe2476",
"sha256": "5c3c99cdc1a2b61045d3c4236dee3f1e9aadd1ed042df5fe2be9d132d6ba17ee"
},
"downloads": -1,
"filename": "mkdocs-snakemake-rule-plugin-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "7c95b21a248bb5786c92870122fe2476",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8, <4",
"size": 35969,
"upload_time": "2024-03-13T10:19:06",
"upload_time_iso_8601": "2024-03-13T10:19:06.357277Z",
"url": "https://files.pythonhosted.org/packages/c9/bb/62e8520a5fc2bd478b9768faa5ec6111831cfba601d3e1204878e415564a/mkdocs-snakemake-rule-plugin-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 10:19:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smeds",
"github_project": "mkdocs-snakemake-rule-plugin",
"github_not_found": true,
"lcname": "mkdocs-snakemake-rule-plugin"
}
JSON
