Metadata-Version: 2.1
Name: rd2md
Version: 1.0.0
Summary: Converter from R docs to markdown
Home-page: https://github.com/comet-ml/rd2md
Author: rd2md development team
License: MIT License
Keywords: python,r
Platform: Linux
Platform: Mac OS X
Platform: Windows
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# 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
* 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` and
`R/man/Experiment.Rd` do this:

```shell
rd2md R/man documentation create_experiment Experiment
```
