# rd2md
A converter to transform R doc files (.Rd) into markdown files (.md).
## Installation
```shell
pip install rd2md
```
## Usage
In the following command-line examples you can use `rd2md` or `python -m rd2md`.
```shell
rd2md [RD-DIRECTORY] [MD-DIRECTORY] BASE-FILENAME-1 BASE-FILENAME-2 ...
```
where:
* [RD-DIRECTORY] is the directory of .Rd files (eg, `R/man`)
* [MD-DIRECTORY] is the output directory for markdown files
* BASE-FILENAME is the name of an Rd file without the directory or extension
## Example
To use `R/man` as the directory of Rd files, and `documentation` as
the output directory, converting `R/man/create_experiment.Rd` to
`documentation/create_experiment.md` and
`R/man/Experiment.Rd` to `documentation/Experiment.md` do this:
```shell
rd2md R/man documentation create_experiment Experiment
```
Raw data
{
"_id": null,
"home_page": "https://github.com/comet-ml/rd2md",
"name": "rd2md",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "python,r",
"author": "rd2md development team",
"author_email": "",
"download_url": "",
"platform": "Linux",
"description": "# rd2md\n\nA converter to transform R doc files (.Rd) into markdown files (.md).\n\n## Installation\n\n```shell\npip install rd2md\n```\n\n## Usage\n\nIn the following command-line examples you can use `rd2md` or `python -m rd2md`.\n\n```shell\nrd2md [RD-DIRECTORY] [MD-DIRECTORY] BASE-FILENAME-1 BASE-FILENAME-2 ...\n```\n\nwhere:\n\n* [RD-DIRECTORY] is the directory of .Rd files (eg, `R/man`)\n* [MD-DIRECTORY] is the output directory for markdown files\n* BASE-FILENAME is the name of an Rd file without the directory or extension\n\n## Example\n\nTo use `R/man` as the directory of Rd files, and `documentation` as\nthe output directory, converting `R/man/create_experiment.Rd` to \n`documentation/create_experiment.md` and\n`R/man/Experiment.Rd` to `documentation/Experiment.md` do this:\n\n```shell\nrd2md R/man documentation create_experiment Experiment\n```\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Converter from R docs to markdown",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/comet-ml/rd2md"
},
"split_keywords": [
"python",
"r"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "85225bbb5803017b9d99b21609722711a295025da119c85985e05dada3d010a2",
"md5": "fc648a3be9d90acb79f7478fc37e7ece",
"sha256": "e15ee45e57968bb0f8fcfda537047820949a2f45dee26f12e3737b74325e212d"
},
"downloads": -1,
"filename": "rd2md-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc648a3be9d90acb79f7478fc37e7ece",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 10944,
"upload_time": "2023-11-11T14:17:46",
"upload_time_iso_8601": "2023-11-11T14:17:46.073725Z",
"url": "https://files.pythonhosted.org/packages/85/22/5bbb5803017b9d99b21609722711a295025da119c85985e05dada3d010a2/rd2md-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-11 14:17:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "comet-ml",
"github_project": "rd2md",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rd2md"
}
JSON
