kivy/doc
RobertF fd12906efa
Android Lifecycle convergence (#7989)
* 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>
2022-10-01 11:27:05 +02:00
..
sources Android Lifecycle convergence (#7989) 2022-10-01 11:27:05 +02:00
Makefile Use python3 if it's present. 2020-10-16 13:41:57 -04:00
README.md Improve and refactor doc readme 2017-04-22 14:25:39 -05:00
__init__.py tests/test_doc_gallery.py - Create test for gallery.py 2015-02-11 20:21:52 -08:00
autobuild.py Fixes NO DOCUMENTATION (module kivy.uix.recycleview) (#7916) 2022-08-16 15:34:56 +02:00
doc-requirements.txt Sphinx: Use class instead of instance in add_lexer + Fixes search on sphinx>1.7.9 (#7623) 2021-09-14 21:27:19 +02:00

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/.