diff --git a/doc/sources/gettingstarted/diving.rst b/doc/sources/gettingstarted/diving.rst index 31fe801ab..6f8e933d4 100644 --- a/doc/sources/gettingstarted/diving.rst +++ b/doc/sources/gettingstarted/diving.rst @@ -6,23 +6,23 @@ Diving in To further get into kivy take a look at :doc:`/index` -Kivy comes with a set of :doc:`examples` in the ``examples`` directory. +Kivy comes with a set of :doc:`examples` in the ``kivy_installation/examples`` directory. You should try modifying/improving/adapting them to your needs. Browse the `snippet wiki `_ . You can even add your snippet in the user snippets section. -Understand the basics about `kivy graphics `_ +Understand the basics about :mod:`kivy graphics ` -Take a look at the built-in `widgets `_ +Take a look at the built-in :mod:`widgets ` -Follow the `programming guide `_ to get even more familiar with kivy. +Follow the :doc:`/guide-index` to get even more familiar with kivy. -See how to use different `Modules `_ like the Inspector for live inspection in the modules section. +See how to use different :mod:`Modules ` like the Inspector for live inspection in the modules section. -Learn how to handle custom `Input `_ +Learn how to handle custom :mod:`Input ` -See how kivy has been extended with `extensions `_ support. +See how kivy has been extended with :mod:`extensions ` support. -Familiarize yourself with the `kivy framework `_ +Familiarize yourself with the :mod:`kivy framework ` Kivy is open source so you can **contribute** , take a look at :doc:`/contribute` section to see the guidelines. diff --git a/doc/sources/gettingstarted/drawing.rst b/doc/sources/gettingstarted/drawing.rst index f19ff38e4..9e5e7ead0 100644 --- a/doc/sources/gettingstarted/drawing.rst +++ b/doc/sources/gettingstarted/drawing.rst @@ -17,4 +17,4 @@ In both cases the canvas of the MyWidget is re-drawn whenever the ``position`` o You can use **canvas.before** or **canvas.after** . This allows you to separate your instructions based on when you want them to happen. -For an in-depth look at how Kivy's graphics are handled, look `here. `_ +For an in-depth look at how Kivy's graphics are handled, look :mod:`here. ` diff --git a/doc/sources/gettingstarted/examples.rst b/doc/sources/gettingstarted/examples.rst index 1500a0550..51796b08b 100644 --- a/doc/sources/gettingstarted/examples.rst +++ b/doc/sources/gettingstarted/examples.rst @@ -58,7 +58,7 @@ Examples .. |tws_dir| replace:: ./examples/frameworks/twisted .. |tws_file| replace:: echo_client_app.py .. |tws_file2| replace:: echo_server_app.py -.. |tws_desc| replace:: A clent and server app using `twisted-inside-kivy `__ +.. |tws_desc| replace:: A clent and server app using :doc:`Twisted inside Kivy ` .. |gst_dir| replace:: ./examples/gestures .. |gst_file| replace:: gesture_board.py @@ -66,7 +66,7 @@ Examples .. |kv_dir| replace:: ./examples/guide/designwithkv .. |kv_file| replace:: main.py -.. |kv_desc| replace:: Programming Guide examples on how to `design with kv lang `__. +.. |kv_desc| replace:: Programming Guide examples on how to :doc:`design with kv lang ` .. |fwd_dir| replace:: ./examples/guide/firstwidget .. |fwd_file| replace:: 1_skeleton.py @@ -75,11 +75,11 @@ Examples .. |fwd_file4| replace:: 4_draw_line.py .. |fwd_file5| replace:: 5_random_colors.py .. |fwd_file6| replace:: 6_button.py -.. |fwd_desc| replace:: Programming Guide examples `Your first widget `__ . +.. |fwd_desc| replace:: Programming Guide examples :doc:`Your first widget ` .. |qst_dir| replace:: ./examples/guide/quickstart .. |qst_file| replace:: main.py -.. |qst_desc| replace:: Programming Guide `guide/quickstart `__ example. +.. |qst_desc| replace:: Programming Guide :doc:`guide/quickstart ` example. .. |kin_dir| replace:: ./examples/kinect .. |kin_file| replace:: main.py diff --git a/doc/sources/gettingstarted/framework.rst b/doc/sources/gettingstarted/framework.rst index 7a1964b9b..a42310cf9 100644 --- a/doc/sources/gettingstarted/framework.rst +++ b/doc/sources/gettingstarted/framework.rst @@ -17,10 +17,10 @@ Non-widget stuff .. |clock_text| replace:: :class:`Clock ` provides you with a convenient way to do jobs at set time intervals and is preferred over *sleep()* which would block the kivy Event Loop. These intervals can be set relative to the OpenGL Drawing instructions, :ref:`before ` or :ref:`after ` frame. Clock also provides you with a way to create :ref:`triggered events ` that are grouped together and only called once before the next frame. -.. |sched_once| replace:: `Clock.schedule_once `__ -.. |sched_intrvl| replace:: `Clock.schedule_interval `__ -.. |unsched| replace:: `Clock.unschedule `__ -.. |trigger| replace:: `Clock.create_trigger `__ +.. |sched_once| replace:: :meth:`~kivy.clock.ClockBase.schedule_once` +.. |sched_intrvl| replace:: :meth:`~kivy.clock.ClockBase.schedule_interval` +.. |unsched| replace:: :meth:`~kivy.clock.ClockBase.unschedule` +.. |trigger| replace:: :meth:`~kivy.clock.ClockBase.create_trigger` .. |urlreq| replace:: :class:`UrlRequest ` is useful to do asynchronous requests without blocking the event loop, and manage the result and progress with callbacks. +------------------+------------------+ diff --git a/doc/sources/gettingstarted/layouts.rst b/doc/sources/gettingstarted/layouts.rst index c6b3d6bc5..1d72b2a4b 100644 --- a/doc/sources/gettingstarted/layouts.rst +++ b/doc/sources/gettingstarted/layouts.rst @@ -10,6 +10,7 @@ Layouts are used to arrange widgets in a perticular manner. :: AnchorLayout: widgets can be anchored to 'top', 'bottom', 'left', 'right', 'center' BoxLayout: widgets are arranged in a box in either 'vertical' or 'horizontal' orientation FloatLayout: Widgets are essentially unrestricted + RelativeLayout: Child widgets are positioned relative to the layout. GridLayout: widgets are arranged in a grid defined by `rows` and `cols` properties StackLayout: widgets are stacked in `lr-tb` (left to right then top to bottom) or `tb-lr` order @@ -20,8 +21,9 @@ size_hint and pos_hint are used to calculate widget's size and position only if However one can set these to None and provide direct values in screen coordinates. For a detailed look at how you can arrange widgets using layouts look in -`AnchorLayout `_ -`BoxLayout `_ -`FloatLayout `_ -`GridLayout `_ -`StackLayout `_ +:mod:`AnchorLayout ` +:mod:`BoxLayout ` +:mod:`FloatLayout ` +:mod:`GridLayout ` +:mod:`StackLayout ` +:mod:`RelativeLayout ` diff --git a/doc/sources/gettingstarted/properties.rst b/doc/sources/gettingstarted/properties.rst index c76bd7fcc..7e2fc2cc0 100644 --- a/doc/sources/gettingstarted/properties.rst +++ b/doc/sources/gettingstarted/properties.rst @@ -33,15 +33,15 @@ provides an ``on_`` event that is called whenever the property's state/value changes . Kivy provides the following properties: - `NumericProperty `_, - `StringProperty `_, - `ListProperty `_, - `ObjectProperty `_, - `BooleanProperty `_, - `BoundedNumericProperty `_, - `OptionProperty `_, - `ReferenceListProperty `_, - `AliasProperty `_, - `DictProperty `_, + :mod:`~kivy.properties.NumericProperty`, + :mod:`~kivy.properties.StringProperty`, + :mod:`~kivy.properties.ListProperty`, + :mod:`~kivy.properties.ObjectProperty`, + :mod:`~kivy.properties.BooleanProperty`, + :mod:`~kivy.properties.BoundedNumericProperty`, + :mod:`~kivy.properties.OptionProperty`, + :mod:`~kivy.properties.ReferenceListProperty`, + :mod:`~kivy.properties.AliasProperty`, + :mod:`~kivy.properties.DictProperty`, For an in-depth explaination, look at :doc:`/api-kivy.properties`