staticdocs v0.1.0.9000

by Hadley Wickham

Make Static HTML Documentation for a Package

Convert package rd files to static html pages, suitable for serving on a website.

Readme

staticdocs

Travis-CI Build Status

staticdocs is designed to make it quick and easy to build a website for your package. You can see staticdocs in action at http://hadley.github.io/staticdocs/: this is the output of staticdocs applied to the latest version of staticdocs.

Installation

staticdocs is not currently available from CRAN, but you can install the development version from github with:

# install.packages("devtools")
devtools::install_github("hadley/staticdocs")

Usage

Run staticdocs from the package directory each time you release your package:

staticdocs::build_site()

This will generate a docs/ directory. The home page will be generated from your package's README.md, and a function reference will be generated from the documentation in the man/ direcftory.

If you are using GitHub, the easiest way to make this your package website is to check into git, then go settings for your repo and make sure that the GitHub pages source is set to "master branch /docs folder".

Functions in staticdocs

Name Description
parse_rd Parse an rd file in to staticdocs format.
build_site Build complete static documentation for a package.
to_html Convert an rdoc to a list of html components.
render_page Render complete page.
sd_section Define a section for the index page
sd_item Define an item in a section of the index.
sd_icon Define the icon for a function.
as.sd_package Return information about a package
No Results!

Details

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/staticdocs)](http://www.rdocumentation.org/packages/staticdocs)