kivy/doc
Edwin Marshall (aspidites) c7408e0b0d - `make clean` removes *.so files
- added exclude_patterns to sphinx config
- changed doc reference to module reference in inputs.rst
- reformated FloatLayout's documentation a bit
- replaced references of RelativeFloatLayout with RelativeLayout
2012-07-25 14:18:54 -05:00
..
sources - `make clean` removes *.so files 2012-07-25 14:18:54 -05:00
Makefile - updated references of ' ::' to '::' where appropriate 2012-07-25 14:18:54 -05:00
README - updated readme 2012-07-25 14:18:54 -05:00
autobuild.py doc: sort submodules by summary, not by name. This is needed to have a consistent menu. 2012-07-16 17:21:45 +02:00

README

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

You can access the API documentation on web :
  * last released version : http://kivy.org/docs/api
  * trunk version, updated nightly  : http://kivy.org/docs/api-trunk/


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/