Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 1023 Bytes

README.rst

File metadata and controls

44 lines (27 loc) · 1023 Bytes

Renjin developer documentation

This repository contains the sources for Renjin's developer documentation. The documentation is created using Sphinx.

Requirements to build the documentation are:

  • Sphinx, obviously.
  • LaTeX, if you want to create a PDF version of the documentation.

e.g. on Ubuntu:

pip3 install -U Sphinx

sudo apt install latexmk

If you want to creat the HTML documentation using the lovely RTD theme you will need to install this as well:

pip install sphinx_rtd_theme

To start

git clone https://github.com/bedatadriven/renjin-docs.git

To create the HTML version:

make html

and to make the PDF version:

make latexpdf

Copyright

Copyright 2014-2016, BeDataDriven.