rd2md
A converter to transform R doc files (.Rd) into markdown files (.md).
Installation
pip install rd2md
Usage
In the following command-line examples you can use rd2md or python -m rd2md.
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:
rd2md R/man documentation create_experiment Experiment
Metadata
Release files for rd2md 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rd2md-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for rd2md-1.0.1-py3-none-any.whl |
Release files / rd2md-1.0.1-py3-none-any.whl
| Download URL | rd2md-1.0.1-py3-none-any.whl |
|---|---|
| Size | 10.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e15ee45e57968bb0f8fcfda537047820949a2f45dee26f12e3737b74325e212d
|
|
BLAKE2b-256 checksum How to use checksums |
85225bbb5803017b9d99b21609722711a295025da119c85985e05dada3d010a2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.13
|
Security for rd2md 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.