kivy/doc
matham d13e221671
Generate Kivy.app on the CI (#7080)
* Re-enable osx app build[build app osx]

* app directory should be in root [build app osx]

* Use re-worked sdk syntax. [build app osx]

* No need to build kivy. [build app osx]

* Use kivy version, not ref name. [build app osx]

* Include examples and use fixes syntax. [build app osx]

* Split app create and test. [build app osx]

* Split app create and test. [build app osx]

* Externalize kivy-examples. [build app osx] [build wheel]

* Externalize kivy-examples. [build app osx] [build wheel]

* No need to download pip manually anymore. [build app osx]

* Fix osx font test from seg-faulting. [build app osx]

* [build app osx] [build wheel osx]

* Don't copy in recursive cycles. [build app osx]

* Don't copy in recursive cycles. [build app osx]

* Set gst regsitery to fix test.

* Update docs. [build app osx] [build wheel]

* Fix gstreamer path [build app osx]

* Use mock only when testing [build app osx][build wheel osx]

* There's no reason to use older xcode, but specifically use osx 10.15. [build app osx]

* Set the gst variables to fix gst not working. [build app osx]

* Set the gst variables to fix gst not working. [build app osx]

* Set the gst variables to fix gst not working. [build app osx][build wheel osx]

* Fix broken tests. [build app osx][build wheel osx]

* Add missing hidapi library to fix osx wheel.

* Fix app environment. [build app osx] [build wheel osx]

* Need to resign hidapi after changing paths. [build app osx] [build wheel osx]
2020-09-15 21:50:34 -04:00
..
sources Generate Kivy.app on the CI (#7080) 2020-09-15 21:50:34 -04: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

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