History

Gabriel Pettier 4b97afa676 Maintain separate docs for different releases This will cause CI to build docs for specific branches when they are pushed to, and to copy the result into a subdirectory of the docs/ directory, instead of the root. The task will also update a "versions.json" file, for the pages to be able to display/select other versions. The doc template is changed slightly to display a select field on top of the quick search, using some js to fill the versions from the generated versions.json file, and to change url when a different version is selected. This has been tested with a local server, trying to emulate the doc structure, but the CI part hasn't been really tested. Known Issues: - the version.json file contains all versions configured to build, but the doc for these might not have been generated yet, which would result in 404 errors. - the logic doesn't know if the current page of the doc exists for the selectable versions, so this will also result in 404 errors when switching to a version that didn't have the current doc page.. - the url manipulation logic is a bit dirty, as it assumes that the path is always of the form of /docs/<version>/…. - theming could certainly be slightly improved.		2018-08-23 18:32:09 +02:00
..
sources	Maintain separate docs for different releases	2018-08-23 18:32:09 +02: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	Fix missing docs for joycursor	2017-04-23 13:43:03 +02:00
doc-requirements.txt	Update doc-requirements.txt	2016-01-09 01:34:53 +02: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:

http://kivy.org/docs

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