Home

This document explains how you can contribute to and modify the xSDK Getting Started documentation.

Current Location of Processed Document

http://xsdk-getting-started.readthedocs.org/en/latest

Installing Sphinx

The Getting Started Guide is generated from reStructructuredText files (files ending with .rst) using the Sphinx system. First check if sphinx is already installed on your system by running

sphinx-build -h

If it is not installed try installing with

pip --install sphinx

If that doesn't work here are a variety of other ways to install sphinx

Cloning the Repository and Building the Document

 git clone [email protected]:xsdk-project/GettingStarted.git
 cd GettingStarted
 make html
 open _build/html/index.html

Editing the Document

The root webpage for the document is in index.rst and all other pages are in docs/*.rst. If you edit any of these documents and then run make html it will update the local documents.