mirror of https://github.com/kivy/kivy.git
24 lines
677 B
ReStructuredText
24 lines
677 B
ReStructuredText
How to read the documentation
|
|
=============================
|
|
|
|
The documentation is seperated in 2 parts:
|
|
|
|
- the Programming Guide: it's a must read to understand the Kivy
|
|
basics, specially if you never done GUI programming before.
|
|
- the API: all the functions, classes, methods are explained.
|
|
|
|
|
|
Importing a class
|
|
-----------------
|
|
|
|
The API part is autogenerated from the source code. If you take any class,
|
|
it will be generated like this:
|
|
|
|
.. image:: images/api-button.jpg
|
|
|
|
It should be read like this: the "Button" class is into the "kivy.uix.button"
|
|
module. So if you want to import that class in your code, write that::
|
|
|
|
from kivy.uix.button import Button
|
|
|