tree: 675b16ddefd7d0b375b5c77d1953e21b8f7f5ed8 [path history] [tgz]
  1. Doxyfile
  2. README.md
  3. _static/
  4. _templates/
  5. build.sh
  6. conf.py
  7. en/
  8. notebook/
  9. zh/
doc/README.md

How to Contribute to Documentation

Website

This document gives step-by-step instructions for deploying SINGA website.

SINGA website is built by Sphinx >=1.4.4 from a source tree stored in git: https://github.com/apache/incubator-singa/tree/master/doc.

To install Sphinx:

$ pip install -U Sphinx

To install the markdown support for Sphinx:

$ pip install recommonmark

To install the rtd theme:

$ pip install sphinx_rtd_theme

You can build the website by executing the following command from the doc folder:

$ ./build.sh html

Committers can update the SINGA website by following these steps:

$ cd _build
$ svn co https://svn.apache.org/repos/asf/incubator/singa/site/trunk
$ cp -r html/* trunk
# svn add <newly added html files>
$ svn commit -m "commit messages" --username  <committer ID> --password <password>

CPP API

To generate docs, run “doxygen” from the doc folder (Doxygen >= 1.8 recommended)