| # Apache Usergrid Docs |
| |
| We use Sphinx for documentions. |
| |
| ## Pre requirements |
| |
| * sphinx |
| * pip |
| |
| $ sudo easy_install sphinx |
| $ sudo easy_install pip |
| |
| ## How to gererate docs |
| |
| cd $usergrid/docs |
| make clean html |
| |
| ## How to update documentations in Usergrid site |
| |
| Note that this update is only available for Usergrid PPMC and committers. |
| |
| $ svn --username "APACHE_USERNAME" --password "APACHE_PASSWORD" co https://svn.apache.org/repos/asf/incubator/usergrid/site/ |
| |
| If you added any files: |
| $ svn add <file or directory> |
| |
| Then commit: |
| $ svn ci -m "Some message" |
| |
| To pull down the latest: |
| $ svn update |
