/docs

Zendrive Analytics API Documentation.

Primary LanguageHTML

Zendrive Analytics API Documentation.

Clone the repo:

git clone git@github.com:zendrive/docs.git

Install sphinx:

sudo pip install sphinx

cd into the docs/analytics-api directory:

cd docs/analytics-api

Build the documentation:

make html

View the generated html in a browser:

firefox docs/analytics-api/_build/html/index.html

Resources

Our docs are reST (reStructuredText, *.rst) files with some Sphinx-specific directives. To learn reST and Sphinx (documentation framework), refer to:

http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

http://sphinx-doc.org/rest.html