kivy/doc
Thomas-Karl Pietrowski 930041a3ca Adding comment for the user about appearing errors when building pdf docs 2015-01-25 11:35:52 +01:00
..
sources doc: added ScatterLayout to 'getting started' guide 2015-01-24 10:49:32 +02:00
Makefile Adding comment for the user about appearing errors when building pdf docs 2015-01-25 11:35:52 +01:00
README Bring sdl2 in line with current master and other fixes to make things usable. Sponsored by ScramSoft. 2014-08-23 17:15:04 +05:30
autobuild.py Changing text as we don't build only html docs.. 2015-01-24 17:23:59 +01:00

README

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

You can access the latest documentation on the web :
  * http://kivy.org/docs


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

You need to install :

  * Python Sphinx
    - Where apt-get is available :
          apt-get install python-sphinx
    - On Windows :
          Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
          To install pip, do python setup.py install in the pip directory.
          Now do :
          pip install sphinx
          pip install blockdiag
          pip install sphinxcontrib-blockdiag
          pip install seqdiag
          pip install sphinxcontrib-seqdiag
          pip install actdiag
          pip install sphinxcontrib-actdiag
          pip install nwdiag
          pip install sphinxcontrib-nwdiag

  * Latest kivy

Generate documentation using make::
  make html

Documentation will be accessible in build/html/