| Title: | Convert R Package Documentation to a 'readthedocs' Website |
|---|---|
| Description: | Convert R package documentation to a 'readthedocs' website. |
| Authors: | Mark Padgham [aut, cre] |
| Maintainer: | Mark Padgham <[email protected]> |
| License: | GPL-3 |
| Version: | 0.1.0.002 |
| Built: | 2024-09-19 06:14:46 UTC |
| Source: | https://github.com/ropenscilabs/r2readthedocs |
readthedocs formatConvert package documentation to readthedocs format
r2readthedocs(path = here::here(), dev = FALSE, open = TRUE)r2readthedocs(path = here::here(), dev = FALSE, open = TRUE)
path |
Path to local R package with documentation to be converted |
dev |
If |
open |
If |
TRUE (invisibly) if documentation successfully converted.
Build the RTD site
rtd_build(path = ".", dev = FALSE)rtd_build(path = ".", dev = FALSE)
path |
Path to local R package with documentation to be converted |
dev |
If |
_build directoryClean the RTD _build directory
rtd_clean(path = ".", full = FALSE)rtd_clean(path = ".", full = FALSE)
path |
Path to local R package with documentation to be converted |
full |
If |
Make a dummy package for testing 'r2readthedocs' functions
rtd_dummy_pkg(base_dir = tempdir(), pkg_name = "demo")rtd_dummy_pkg(base_dir = tempdir(), pkg_name = "demo")
base_dir |
Base directory in which package is to be constructed (as a sub-directory) |
pkg_name |
Name of package, which will become a sub-directory of
|
Path to root directory of resultant package
Open the main RTD 'html' page in default browser
rtd_open(path = ".")rtd_open(path = ".")
path |
Path to local R package with documentation to be converted |