The documentation for InaSAFE is written using ReSTructured text (.rst) and the Sphinx documentation builder.
The best way to learn how to write .rst is to look at the source of existing documentation - the markup syntax is very simple. There are a number of useful tags that you can use to make your documentation clear and visually interesting, the more commonly used in this document are listed below. For a more detailed list, please visit the Sphinx Inline Markup page
A complete list of supported .rst markup is also available here.
Following are a few tips for documentation writers:
Helping writing the documentation is an easy task. The only thing you need to have is a local copy of the InaSAFE documentation branch.
In order to clone the documentation of InaSAFE you only have to follow this procedure:
This is a one-time process. You do not need to repeat it - it is here for reference purposes only.
Things you have to have to be able to help with documentation:
Creating a GitHub account is done by clicking on the Sign up for free button on https://github.com/ and filling out the necessary fields.
This documentation assumes that you have the whole InaSAFE source available under $HOME/dev/python/...
Clone your forked github InaSAFE documentation by entering following command:
git clone https://github.com/<your username>/inasafe-doc.git
Search for the .rst file you’d like to extend/fix and work on it.
Afterwards commit your local changes to your local clone with the command:
git commit -a -m”fixed a typo”
After that you have to push your local changes to your github fork with:
You can than do a pull request on github to request your changes to be reviewed and taken into the official documentation.