S2Graph Documentation

Dependencies

Python

Sphinx

Read the Docs Sphinx Theme

I used pip to install Python module. I used virtualenv to isolate the Python environment.

Depending on your environment, the tools(pip, virtualenv) may not be required

Quickstart

All work is done under the s2graph/doc folder.

cd doc

Creating a virtualenv environment for documnet build

If pip is not installed, you need to install it first by referring to the link: https://pip.pypa.io/en/stable/installing/

pip install virtualenv

virtualenv -p python s2graph_doc
source s2graph_doc/bin/activate

install sphinx and theme

pip install Sphinx
pip install sphinx_rtd_theme 

Building

make html

Viewing

# python 2
pushd build/html && python -m SimpleHTTPServer 3000 

# python 3
pushd build/html && python -m http.server 3000 

Screenshot