-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This document explains how you can contribute to and modify the xSDK Getting Started documentation.
http://xsdk-getting-started-guide.readthedocs.org/en/latest
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 already installed, try installing with
pip --install sphinx
If that doesn't work, here are a variety of other ways to install Sphinx.
git clone [email protected]:xsdk-project/GettingStarted.git
cd GettingStarted
make html
open _build/html/index.html
The root webpage for the document is in index.rst; 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.
You can add more files in the usual way with
touch docs/myfile.rst
git add docs/myfile.rst
edit file
To update the repository and have the Online Webpages at http://xsdk-getting-started-guide.readthedocs.org/en/latest be automatically updated, simply push your changes to the repository (the update of the document site may take a minute or two).
git commit -a
git push
You can also update the document pages on line at http://github.com/xsdk-project/GettingStarted by clicking on a page to display it and then selecting the Pencil icon on the upper right corner of the page. When you save and commit your changes, the Online Website will automatically be updated.
- On the subpackages list have a list that allows expanding and closing each description instead of the static display of all of them