kivy/doc
EdTheDev df5a1ecc02 Expanded the 'Documentation Contributions' section to make it clear where the documentation is stored, and how changes are expected to be handled.
Also added a link to ReStructuredText documentation, mentioned the dependency on python-sphinx, and added the command to rebuild the HTML.
2012-10-02 12:34:49 -05:00
..
sources Expanded the 'Documentation Contributions' section to make it clear where the documentation is stored, and how changes are expected to be handled. 2012-10-02 12:34:49 -05:00
Makefile more corrections to docs 2012-08-09 13:50:05 +02:00
README README links to correct API doc location 2012-08-09 13:20:14 +02:00
autobuild.py dont activate the warning as error on sphinx, we need the gettingstarted generated, even if its not referenced in the toc + optim to not rewrite rst file if the content didnt change, it prevent sphinx to reread the source. 2012-07-28 08:05:05 +02:00

README

Kivy - Documentation
====================

You can access the API documentation on web :
  * last released version : http://kivy.org/docs/api-index.html


How to build the documentation
------------------------------

You need to install :
  * Python Sphinx (apt-get install python-sphinx)
  * Latest kivy

Generate documentation using make::
  make html

Documentation will be accessible in build/html/