Package 'r2readthedocs'

Convert package documentation to readthedocs format

Description

Convert package documentation to readthedocs format

Usage

r2readthedocs(path = here::here(), dev = FALSE, open = TRUE)

Arguments

path	Path to local R package with documentation to be converted
dev	If TRUE, include function documentation of all dependency packages in site.
open	If TRUE, open the documentation site in default browser.

Value

TRUE (invisibly) if documentation successfully converted.

---

Build the RTD site

Description

Build the RTD site

Usage

rtd_build(path = ".", dev = FALSE)

Arguments

path	Path to local R package with documentation to be converted
dev	If TRUE, include function documentation of all dependency packages in site.

---

Clean the RTD ⁠_build⁠ directory

Description

Clean the RTD ⁠_build⁠ directory

Usage

rtd_clean(path = ".", full = FALSE)

Arguments

path	Path to local R package with documentation to be converted
full	If TRUE, also clean R package files, including vignettes and help files. Use r2readthedocs to re-generate these.

---

Make a dummy package for testing 'r2readthedocs' functions

Description

Make a dummy package for testing 'r2readthedocs' functions

Usage

rtd_dummy_pkg(base_dir = tempdir(), pkg_name = "demo")

Arguments

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 base_dir.

Value

Path to root directory of resultant package

---

Open the main RTD 'html' page in default browser

Description

Open the main RTD 'html' page in default browser

Usage

rtd_open(path = ".")

Arguments

path	Path to local R package with documentation to be converted

---