kivy/doc
matham 8950509a19 Update installtion for 3.5 wheels. 2017-01-24 18:36:15 -05:00
..
sources Update installtion for 3.5 wheels. 2017-01-24 18:36:15 -05:00
Makefile Fix remaining misspellings 2016-09-07 11:23:44 +02:00
README.md Updated readme to show easier ways to install sphinx on OSX or other systems with pip enabled 2016-06-23 21:19:39 +02:00
__init__.py tests/test_doc_gallery.py - Create test for gallery.py 2015-02-11 20:21:52 -08:00
autobuild.py remove extension support, closes #3594 2016-12-17 18:58:08 +02:00
doc-requirements.txt Update doc-requirements.txt 2016-01-09 01:34:53 +02:00
gallery.py Fix remaining misspellings 2016-09-07 11:23:44 +02:00

README.md

Kivy - Documentation

You can access the latest documentation on the web:

How to build the documentation

You need to install:

  • Python Sphinx

    • With pip:
    pip install sphinx
    
    • With apt-get:
    apt-get install python-sphinx
    
    • With MacPorts:
    port install py34-sphinx
    
    • On Windows (or from inside your virtualenv):

      Get pip (https://pypi.python.org/pypi/pip). You'll use it to install the dependencies.
      
      To install pip, run python setup.py install in the pip directory. Now run:
      ```
      pip install sphinxcontrib-blockdiag sphinxcontrib-seqdiag
      pip install sphinxcontrib-actdiag sphinxcontrib-nwdiag
      ```
      Or just use the provided `doc-requirements.txt`:
      ```
      pip install -r doc-requirements.txt
      ```
      
  • Latest kivy

Generate documentation using make: make html.

Documentation will be accessible in build/html/.