https://github.com/gagolews/Rd2rst
[EXPERIMENTAL] Convert an R package's documentation to Markedly- (MyST) or reStructuredText (rST)
https://github.com/gagolews/Rd2rst
documentation knitr myst pandoc r restructuredtext rst sphinx
Last synced: 28 days ago
JSON representation
[EXPERIMENTAL] Convert an R package's documentation to Markedly- (MyST) or reStructuredText (rST)
- Host: GitHub
- URL: https://github.com/gagolews/Rd2rst
- Owner: gagolews
- License: other
- Created: 2020-08-16T10:43:35.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T20:19:16.000Z (10 months ago)
- Last Synced: 2025-03-16T22:37:53.022Z (about 1 month ago)
- Topics: documentation, knitr, myst, pandoc, r, restructuredtext, rst, sphinx
- Language: R
- Homepage:
- Size: 88.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: NEWS
- License: LICENSE
Awesome Lists containing this project
- awesome-myst - Rd2rst
README
# `Rd2rst` [EXPERIMENTAL]
## Convert R package Documentation to Markedly- (MyST) or reStructuredText (rST)
> Note: rST support is deprecated and probably doesn't work anymore.
Author: [Marek Gagolewski](https://www.gagolewski.com)
System requirements: `pandoc`
> Caution: not tested on other systems.
This package in its current version is not intended to serve any
purpose other than generating the R API documentation
of the
[genieclust](https://genieclust.gagolewski.com),
[stringi](https://stringi.gagolewski.com),
[stringx](https://stringx.gagolewski.com),
and [realtest](https://realtest.gagolewski.com)
packages.
I'm applying a super-lazy approach here: the complete manual bundle
is generated from the HTML version as produced by `R CMD INSTALL --html`.
It's because `tools::Rd2HTML()` does a pretty good job
outputting well-structured and easily-digestible source files.
It also does cross-referencing right.
However, it's far from perfect with regards to mathematical formulae.
I have no time to implement a full-fledged parser.
Feel free to contact me to discuss further ideas and maybe
we can come up with something more useful together.
Also, it would be nice to implement a standalone Sphinx domain for R.
See
and .
Want to do it together? Drop me an email. Cheers.