packagedocs: Build Website of Package Documentation

Share:

Build a package documentation and function reference site and use it as the package vignette.

Author
Ryan Hafen [aut, cre], Barret Schloerke [aut], Hadley Wickham [aut, cph] (Rd munging code from staticdocs package (see comments in 'z_staticdocs' source))
Date of publication
2016-11-04 00:41:33
Maintainer
Ryan Hafen <rhafen@gmail.com>
License
MIT + file LICENSE
Version
0.4.0
URLs

View on CRAN

Man pages

build_vignettes
Build CRAN and gh-pages vignettes
check_output
Check output for warnings and errors
check_rd_index
Check rd_index.yaml for missing or extra topics
deploy_travis
Deploy to Github Pages from Travis-CI
init_vignettes
Initialize a new packagedocs project
package_docs
Generate package docs
rd_link
Translate a reference to a package function into a link to...
rd_template
Generate the text to put in a rd.rmd file to build a package...
read_rmd_yaml
Read .Rmd yaml header
render_redirect
Render vignette redirect
secure_token
Secure personal access token
to_html
Convert an rdoc to a list of html components.
use_travis
Use Travis CI

Files in this package

packagedocs
packagedocs/inst
packagedocs/inst/html_assets
packagedocs/inst/html_assets/highlight
packagedocs/inst/html_assets/highlight/tomorrow.css
packagedocs/inst/html_assets/highlight/highlight.pack.js
packagedocs/inst/html_assets/template.html
packagedocs/inst/html_assets/fontawesome
packagedocs/inst/html_assets/fontawesome/css
packagedocs/inst/html_assets/fontawesome/css/font-awesome.min.css
packagedocs/inst/html_assets/fontawesome/fonts
packagedocs/inst/html_assets/fontawesome/fonts/fontawesome-webfont.ttf
packagedocs/inst/html_assets/fontawesome/fonts/fontawesome-webfont.eot
packagedocs/inst/html_assets/fontawesome/fonts/FontAwesome.otf
packagedocs/inst/html_assets/fontawesome/fonts/fontawesome-webfont.woff
packagedocs/inst/html_assets/fontawesome/fonts/fontawesome-webfont.woff2
packagedocs/inst/html_assets/fontawesome/fonts/fontawesome-webfont.svg
packagedocs/inst/html_assets/packagedocs
packagedocs/inst/html_assets/packagedocs/pd.css
packagedocs/inst/html_assets/packagedocs/pd.js
packagedocs/inst/html_assets/packagedocs/pd-sticky-toc.js
packagedocs/inst/html_assets/packagedocs/pd-collapse-toc.js
packagedocs/inst/html_assets/bootstrap
packagedocs/inst/html_assets/bootstrap/css
packagedocs/inst/html_assets/bootstrap/css/bootstrap.min.css
packagedocs/inst/html_assets/bootstrap/shim
packagedocs/inst/html_assets/bootstrap/shim/respond.min.js
packagedocs/inst/html_assets/bootstrap/shim/html5shiv.min.js
packagedocs/inst/html_assets/bootstrap/js
packagedocs/inst/html_assets/bootstrap/js/bootstrap.min.js
packagedocs/inst/html_assets/bootstrap/fonts
packagedocs/inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.ttf
packagedocs/inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.svg
packagedocs/inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.woff
packagedocs/inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.eot
packagedocs/inst/html_assets/bootstrap/fonts/glyphicons-halflings-regular.woff2
packagedocs/inst/html_assets/sticky-kit
packagedocs/inst/html_assets/sticky-kit/sticky-kit.min.js
packagedocs/inst/html_assets/jquery-easing
packagedocs/inst/html_assets/jquery-easing/jquery.easing.min.js
packagedocs/inst/rd_template
packagedocs/inst/rd_template/cran_template.html
packagedocs/inst/rd_template/rd_template.Rmd
packagedocs/inst/rd_template/rd_main_template.Rmd
packagedocs/inst/doc
packagedocs/inst/doc/rd.html
packagedocs/inst/doc/images
packagedocs/inst/doc/images/github_pat.png
packagedocs/inst/doc/rd.Rmd
packagedocs/inst/doc/docs.Rmd
packagedocs/inst/doc/docs.html
packagedocs/inst/doc/github_pat.png
packagedocs/inst/rmarkdown
packagedocs/inst/rmarkdown/templates
packagedocs/inst/rmarkdown/templates/packagedocs
packagedocs/inst/rmarkdown/templates/packagedocs/skeleton
packagedocs/inst/rmarkdown/templates/packagedocs/skeleton/rd_index.yaml
packagedocs/inst/rmarkdown/templates/packagedocs/skeleton/skeleton.Rmd
packagedocs/inst/rmarkdown/templates/packagedocs/skeleton/rd_skeleton.Rmd
packagedocs/tests
packagedocs/tests/testthat.R
packagedocs/tests/testthat
packagedocs/tests/testthat/test_to_html.R
packagedocs/tests/testthat/test_something.R
packagedocs/NAMESPACE
packagedocs/NEWS.md
packagedocs/R
packagedocs/R/z_staticdocs_highlight.R
packagedocs/R/utils.R
packagedocs/R/on_load.R
packagedocs/R/check_output.R
packagedocs/R/rd_template.R
packagedocs/R/render_shell.R
packagedocs/R/z_staticdocs_rd.R
packagedocs/R/staticdocs.R
packagedocs/R/travis.R
packagedocs/R/devtools.R
packagedocs/R/rd_link.R
packagedocs/R/z_staticdocs_util.R
packagedocs/R/init.R
packagedocs/R/keywords.R
packagedocs/R/package_docs.R
packagedocs/R/z_staticdocs_build-index.R
packagedocs/R/z_staticdocs_to_html.R
packagedocs/R/z_staticdocs_package.R
packagedocs/R/test_file.R
packagedocs/R/packagedocs-package.R
packagedocs/R/purl_docs.R
packagedocs/R/rd_index.R
packagedocs/vignettes
packagedocs/vignettes/rd_index.yaml
packagedocs/vignettes/images
packagedocs/vignettes/images/github_pat.png
packagedocs/vignettes/.install_extras
packagedocs/vignettes/rd.Rmd
packagedocs/vignettes/docs.Rmd
packagedocs/README.md
packagedocs/MD5
packagedocs/build
packagedocs/build/vignette.rds
packagedocs/DESCRIPTION
packagedocs/man
packagedocs/man/rd_template.Rd
packagedocs/man/use_travis.Rd
packagedocs/man/init_vignettes.Rd
packagedocs/man/secure_token.Rd
packagedocs/man/build_vignettes.Rd
packagedocs/man/to_html.Rd
packagedocs/man/read_rmd_yaml.Rd
packagedocs/man/package_docs.Rd
packagedocs/man/check_rd_index.Rd
packagedocs/man/rd_link.Rd
packagedocs/man/deploy_travis.Rd
packagedocs/man/check_output.Rd
packagedocs/man/render_redirect.Rd
packagedocs/.Rinstignore
packagedocs/LICENSE