Skip to content

[EXPERIMENTAL] Convert an R package's documentation to Markedly- (MyST) or reStructuredText (rST)

License

Notifications You must be signed in to change notification settings

gagolews/Rd2rst

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

System requirements: pandoc

Caution: not tested on humans and other animals. This package in its current version is not intended to serve any purpose other than generating the awesome API documentation for the genieclust, stringi, stringx, and realtest 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 <pkg> --html. It's because tools::Rd2HTML() does a pretty good job by outputting well-structured and easily-digestible source files.

It also does cross-referencing right.

Yet, 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 https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html and https://www.sphinx-doc.org/en/master/extdev/domainapi.html. Want to do it together? Drop me an email. Cheers.

About

[EXPERIMENTAL] Convert an R package's documentation to Markedly- (MyST) or reStructuredText (rST)

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published