mirror of https://github.com/kivy/kivy.git
Doc: GettingStarted: replace absolute paths with relative
This commit is contained in:
parent
a3b082e4d1
commit
c0cdbe74ce
|
@ -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 <http://wiki.kivy.org>`_ . You can even add your snippet in the user snippets section.
|
||||
|
||||
Understand the basics about `kivy graphics <http://kivy.org/docs/api-kivy.graphics.html#module-kivy.graphics>`_
|
||||
Understand the basics about :mod:`kivy graphics <kivy.graphics>`
|
||||
|
||||
Take a look at the built-in `widgets <http://kivy.org/docs/api-kivy.uix.html>`_
|
||||
Take a look at the built-in :mod:`widgets <kivy.uix>`
|
||||
|
||||
Follow the `programming guide <http://kivy.org/docs/guide-index.html>`_ 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 <http://kivy.org/docs/api-kivy.modules.html>`_ like the Inspector for live inspection in the modules section.
|
||||
See how to use different :mod:`Modules <kivy.modules>` like the Inspector for live inspection in the modules section.
|
||||
|
||||
Learn how to handle custom `Input <http://kivy.org/docs/api-kivy.input.html>`_
|
||||
Learn how to handle custom :mod:`Input <kivy.input>`
|
||||
|
||||
See how kivy has been extended with `extensions <http://kivy.org/docs/api-kivy.ext.html#module-kivy.ext>`_ support.
|
||||
See how kivy has been extended with :mod:`extensions <kivy.ext>` support.
|
||||
|
||||
Familiarize yourself with the `kivy framework <http://kivy.org/docs/api-kivy.html#module-kivy>`_
|
||||
Familiarize yourself with the :mod:`kivy framework <kivy>`
|
||||
|
||||
Kivy is open source so you can **contribute** , take a look at :doc:`/contribute` section to see the guidelines.
|
||||
|
|
|
@ -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. <http://kivy.org/docs/api-kivy.graphics.html>`_
|
||||
For an in-depth look at how Kivy's graphics are handled, look :mod:`here. <kivy.graphics>`
|
||||
|
|
|
@ -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 <http://kivy.org/docs/guide/other-frameworks.html?highlight=twisted#using-twisted-inside-kivy>`__
|
||||
.. |tws_desc| replace:: A clent and server app using :doc:`Twisted inside Kivy </guide/other-frameworks>`
|
||||
|
||||
.. |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 <http://kivy.org/docs/guide/designwithkv.html>`__.
|
||||
.. |kv_desc| replace:: Programming Guide examples on how to :doc:`design with kv lang </guide/designwithkv>`
|
||||
|
||||
.. |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 <http://kivy.org/docs/guide/firstwidget.html>`__ .
|
||||
.. |fwd_desc| replace:: Programming Guide examples :doc:`Your first widget </guide/firstwidget>`
|
||||
|
||||
.. |qst_dir| replace:: ./examples/guide/quickstart
|
||||
.. |qst_file| replace:: main.py
|
||||
.. |qst_desc| replace:: Programming Guide `guide/quickstart <http://kivy.org/docs/guide/quickstart.html>`__ example.
|
||||
.. |qst_desc| replace:: Programming Guide :doc:`guide/quickstart </guide/quickstart>` example.
|
||||
|
||||
.. |kin_dir| replace:: ./examples/kinect
|
||||
.. |kin_file| replace:: main.py
|
||||
|
|
|
@ -17,10 +17,10 @@ Non-widget stuff
|
|||
|
||||
.. |clock_text| replace:: :class:`Clock <kivy.clock.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 <schedule-before-frame>` or :ref:`after <schedule-after-frame>` frame. Clock also provides you with a way to create :ref:`triggered events <triggered-events>` that are grouped together and only called once before the next frame.
|
||||
|
||||
.. |sched_once| replace:: `Clock.schedule_once <http://kivy.org/docs/api-kivy.clock.html?highlight=clock#kivy.clock.ClockBase.schedule_once>`__
|
||||
.. |sched_intrvl| replace:: `Clock.schedule_interval <http://kivy.org/docs/api-kivy.clock.html?highlight=clock#kivy.clock.ClockBase.schedule_interval>`__
|
||||
.. |unsched| replace:: `Clock.unschedule <http://kivy.org/docs/api-kivy.clock.html?highlight=clock#kivy.clock.ClockBase.unschedule>`__
|
||||
.. |trigger| replace:: `Clock.create_trigger <http://kivy.org/docs/api-kivy.clock.html?highlight=clock#kivy.clock.ClockBase.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 <kivy.network.urlrequest.UrlRequest>` is useful to do asynchronous requests without blocking the event loop, and manage the result and progress with callbacks.
|
||||
|
||||
+------------------+------------------+
|
||||
|
|
|
@ -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 <http://kivy.org/docs/api-kivy.uix.anchorlayout.html>`_
|
||||
`BoxLayout <http://kivy.org/docs/api-kivy.uix.boxlayout.html>`_
|
||||
`FloatLayout <http://kivy.org/docs/api-kivy.uix.floatlayout.html>`_
|
||||
`GridLayout <http://kivy.org/docs/api-kivy.uix.gridlayout.html>`_
|
||||
`StackLayout <http://kivy.org/docs/api-kivy.uix.stacklayout.html>`_
|
||||
:mod:`AnchorLayout <kivy.uix.anchorlayout>`
|
||||
:mod:`BoxLayout <kivy.uix.boxlayout>`
|
||||
:mod:`FloatLayout <kivy.uix.floatlayout>`
|
||||
:mod:`GridLayout <kivy.uix.gridlayout>`
|
||||
:mod:`StackLayout <kivy.uix.stacklayout>`
|
||||
:mod:`RelativeLayout <kivy.uix.relativelayout>`
|
||||
|
|
|
@ -33,15 +33,15 @@ provides an ``on_<propertyname>`` event that is called whenever the property's
|
|||
state/value changes .
|
||||
|
||||
Kivy provides the following properties:
|
||||
`NumericProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.NumericProperty>`_,
|
||||
`StringProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.StringProperty>`_,
|
||||
`ListProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.ListProperty>`_,
|
||||
`ObjectProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.ObjectProperty>`_,
|
||||
`BooleanProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.BooleanProperty>`_,
|
||||
`BoundedNumericProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.BoundedNumericProperty>`_,
|
||||
`OptionProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.OptionProperty>`_,
|
||||
`ReferenceListProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.ReferenceListProperty>`_,
|
||||
`AliasProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.AliasProperty>`_,
|
||||
`DictProperty <http://kivy.org/docs/api-kivy.properties.html?highlight=properties#kivy.properties.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`
|
||||
|
|
Loading…
Reference in New Issue