1Welcome to the OpenXPKI documentation. 2 3Reading the documentation online 4================================ 5 6The ReadTheDocs site 7 8http://openxpki.readthedocs.org/en/latest/ 9 10always contains the latest documentation of the upstream project. 11 12 13Reading the documentation offline 14================================= 15 16In order to build the documentation (either for offline reading or for 17contributing) please install Sphinx (http://sphinx.pocoo.org/) and run 18 19make html 20 21in order to build the documentation. 22 23 24Contributing 25============ 26 27If you wish to contribute documentation please fork the OpenXPKI project 28(https://github.com/openxpki/openxpki) on Github. 29 30Checkout the branch you wish to write documentation for (typically either 31master or develop) and branch off a feature branch locally: 32 33git checkout develop 34git branch feature/documentation 35 36Read the Sphinx documentation (http://sphinx.pocoo.org/index.html) before 37contributing. 38Once you are done, push your work to your Github repository and raise a 39Pull Request via the Github infrastructure. 40 41