Permalink
Browse files

- `make clean` removes *.so files

- added exclude_patterns to sphinx config
- changed doc reference to module reference in inputs.rst
- reformated FloatLayout's documentation a bit
- replaced references of RelativeFloatLayout with RelativeLayout
  • Loading branch information...
1 parent 31e494f commit c7408e0b0dce6116668db9c42b90677b709d0728 @aspidites aspidites committed Jul 24, 2012
View
@@ -48,6 +48,7 @@ clean:
-rm .coverage
-rm .noseids
-rm -rf kivy/tests/build
+ -find kivy -iname '*.so' -exec rm {} \;
-find kivy -iname '*.pyc' -exec rm {} \;
-find kivy -iname '*.pyo' -exec rm {} \;
View
@@ -62,12 +62,9 @@
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
-# List of documents that shouldn't be included in the build.
-#unused_docs = []
-
-# List of directories, relative to source directories, that shouldn't be searched
-# for source files.
-#exclude_dirs = []
+# suppress exclusion warnings
+exclude_patterns = ['gettingstarted/*', 'api-index.rst',
+ 'api-kivy.lib.osc.*', 'guide/android.rst', 'guide/layouts.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -96,7 +96,7 @@ profile exists::
if 'angle' in touch.profile:
print 'The touch angle is', touch.a
-You can find a list of available profiles in the :doc:`api-kivy.input.motionevent`
+You can find a list of available profiles in the :mod:`api-kivy.input.motionevent`
documentation.
Touch events
@@ -44,7 +44,6 @@ cdef class Matrix:
[ 4 5 6 7]
[ 8 9 10 11]
[ 12 13 14 15]
-
'''
def __cinit__(self):
View
@@ -15,28 +15,27 @@
.. image:: images/floatlayout.png
:align: right
-For example, if you create a FloatLayout with size of (300, 300)::
+For example, if you create a FloatLayout with size a of (300, 300)::
layout = FloatLayout(size=(300, 300))
- # By default, all widgets have size_hint=(1, 1)
- # So this button will have the same size as
- # the layout
+By default, all widgets have size_hint=(1, 1), so this button will have the
+same size as the layout::
+
button = Button(text='Hello world')
layout.add_widget(button)
- # To create a button of 50% width and 25%
- # height of the layout and positioned at
- # 20, 20, you can do
+To create a button of 50% width and 25% height of the layout and positioned at
+(20, 20), you can do::
+
button = Button(
text='Hello world',
size_hint=(.5, .25),
pos=(20, 20))
-::
+If you want to create a button that will always be the size of layout minus
+20% on each side::
- # If you want to create a button that will always be the size of layout
- # minus 20% on each side:
button = Button(text='Hello world', size_hint=(.6, .6),
pos_hint={'x':.2, 'y':.2})
@@ -53,7 +52,7 @@
'''
-__all__ = ('FloatLayout', 'RelativeFloatLayout')
+__all__ = ('FloatLayout',)
from kivy.uix.layout import Layout
View
@@ -7,24 +7,24 @@
This layout allows you to set relative coordinate for children. If you want
absolute positioning, check :class:`~kivy.uix.floatlayout.FloatLayout`.
-The :class:`RelativeFloatLayout` class behaves just like the regular Float
+The :class:`RelativeLayout` class behaves just like the regular Float
Layout, except that its child widgets are positioned relative to the layout.
-For example, if you create a RelativeFloatLayout, add a widgets with
+For example, if you create a RelativeLayout, add a widgets with
position = (0,0), the child widget will also move, when you change the
-position of the RelativeFloatLayout. The child widgets coordiantes remain
+position of the RelativeLayout. The child widgets coordiantes remain
(0,0), i.e. they are relative to the containing layout.
..note::
- The :class:`RelativeFloatLayout` is implemented as a :class`FloatLayout`
+ The :class:`RelativeLayout` is implemented as a :class`FloatLayout`
inside a :class:`Scatter`.
.. warning::
- Since the actual RelativeFloatLayout is a Scatter, its add_widget and
+ Since the actual RelativeLayout is a Scatter, its add_widget and
remove_widget functions are overwritten to add children to the embedded
- FloatLayout (accessible as `content` property of RelativeFloatLayout)
+ FloatLayout (accessible as `content` property of RelativeLayout)
automatically. So if you want to access the added child elements,
you need self.content.children, instead of self.children.
'''
View
@@ -252,7 +252,7 @@ def get_current_tab(self):
'''Specifies the text displayed on the default tab header.
:data:`default_tab_text` is a :class:`~kivy.properties.StringProperty`,
- default to 'default tab'.
+ defaults to 'default tab'.
'''
default_tab_cls = ObjectProperty(TabbedPanelHeader)
@@ -307,7 +307,7 @@ def set_def_tab(self, new_tab):
'''Holds the default tab.
.. Note:: For convenience, the automatically provided default tab is deleted
- when you change default_tab to something else.
+ when you change default_tab to something else.
:data:`default_tab` is a :class:`~kivy.properties.AliasProperty`
'''
View
@@ -1209,7 +1209,7 @@ def _keyboard_on_key_up(self, window, keycode):
'''
password = BooleanProperty(False)
- '''If True, the widget will display its characters as the character *.
+ '''If True, the widget will display its characters as the character '*'.
.. versionadded:: 1.2.0
View
@@ -355,7 +355,8 @@ def get_node_at_pos(self, pos):
def iterate_open_nodes(self, node=None):
'''Generator to iterate over expanded nodes.
- To get all the open nodes:
+
+ To get all the open nodes::
treeview = TreeView()
# ... add nodes ...

0 comments on commit c7408e0

Please sign in to comment.