Skip to content

rcharts/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Documentation for rCharts

This repository contains the source files used to generate documentation for rCharts. The documentation is built by ReadTheDocs and can be viewed here.

How it Works?

The source files are written in Rrst, which is a reproducible reStructured Text format, supported by knitr. The .Rrst files are knit into .rst files by a custom script. The documentation can be built locally using sphinx, by using the Makefile.

$ git clone https://github.com/rcharts/docs.git
$ cd docs
$ make rst && make html && make latexpdf

How to Contribute

I am still figuring out the best way for others to contribute to this effort. I will update this section once I come up with a minimal set of guidelines.