fd12906efa
* Android pause on back key/gesture Replaces previous divergence between Android and Kivy state machines. * Android exit app when on_pause returns False Corrects previous behavior where Kivy app stops, but Android does not stop. * stop() - set Android state Let Kivy app state follow Android state. * Add pause() * typo * Disambiguate It is unclear it "default case" refers to existence of a return statement, or existence of a method. * add versionadded * pep8 * pep8 * pep8 * Update kivy/app.py Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com> * Update app.py Co-authored-by: Mirko Galimberti <me@mirkogalimberti.com> |
||
---|---|---|
.. | ||
sources | ||
Makefile | ||
README.md | ||
__init__.py | ||
autobuild.py | ||
doc-requirements.txt |
README.md
Kivy - Documentation
You can access the latest documentation on the web:
Contributing
If you intend on editing and contributing documentation, assure the kivy source code is up to date before proceeding. If your documentation is outdated, it could result in merge conflicts.
Install 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
Building the documentation
Generate documentation using make: make html
.
Documentation will be accessible in build/html/
.