kivy/doc
Kristian Sloth Lauszus 59facf6e6f Cross compile wheel for armv7l (Raspberry Pi 4) using Github Actions CI (#6568)
* Cross compile wheel for armv7l (Raspberry Pi 4) using Github Actions CI

Fixes #6567

* Added instruction on how to install Kivy on a Raspberry Pi 4

* Do not package the examples in the wheel

* We can not upload armv7l wheels to PyPI

* Remove all references to KivyPie

* Merge the installations instructions for Raspberry Pi's together

* Build the armv7l wheel on Stretch as well

* Create a copy of the wheel with a armv6l suffix

* The wheels are Raspberry Pi specific
2019-12-21 15:29:04 -05:00
..
sources Cross compile wheel for armv7l (Raspberry Pi 4) using Github Actions CI (#6568) 2019-12-21 15:29:04 -05:00
Makefile Fix remaining misspellings 2016-09-07 11:23:44 +02: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 Don't fail doc gen if pyinstaller is not installed 2019-05-14 20:06:29 -04:00
doc-requirements.txt force to use sphinx 1.7.9 to restore search 2019-06-02 13:57:25 -04:00
gallery.py Docs: Fix docs errors generated by gallery.py 2017-11-12 13:00:25 +01: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/.