Rooba
/
kivy
mirror of https://github.com/kivy/kivy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Revisions to /guide/readingdoc.rst

This commit is contained in:
Zen-CODE 2013-03-29 03:38:47 -05:00
parent 62ab68babf
commit 44d88fc834
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/sources/guide/readingdoc.rst
View File

@ -1,23 +1,23 @@
How to read the documentation
=============================
The documentation is seperated in 2 parts:
The documentation is seperated into 2 parts:
- the Programming Guide: it's a must read to understand the Kivy
basics, specially if you never done GUI programming before.
basics, especially if you have 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:
The API section is autogenerated from the source code. Taking any class,
the documentation will look something like this:
.. image:: images/api-button.jpg
It should be read like this: the "Button" class is in the "kivy.uix.button"
module. So if you want to import that class in your code, write that::
It should be read as follows: the "Button" class is in the "kivy.uix.button"
module. If you want to import the class in your code, you will write::
from kivy.uix.button import Button