mirror of https://github.com/kivy/kivy.git
8950509a19 | ||
---|---|---|
.. | ||
sources | ||
Makefile | ||
README.md | ||
__init__.py | ||
autobuild.py | ||
doc-requirements.txt | ||
gallery.py |
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/
.