mirror of https://github.com/kivy/kivy.git
- trying a more flexible method of suppressing warnings
- added reference to clock documentation
This commit is contained in:
parent
70d756e9dd
commit
4ae1b14d11
|
@ -3,8 +3,8 @@
|
|||
|
||||
# You can set these variables from the command line.
|
||||
PYTHON = python
|
||||
#SPHINXOPTS = -W
|
||||
SPHINXOPTS =
|
||||
SPHINXOPTS = -W
|
||||
#SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
|
||||
|
|
|
@ -63,8 +63,7 @@ release = kivy.__version__
|
|||
today_fmt = '%B %d, %Y'
|
||||
|
||||
# suppress exclusion warnings
|
||||
#exclude_patterns = ['gettingstarted/*', 'api-index.rst',
|
||||
# 'api-kivy.lib.osc.*', 'guide/layouts.rst']
|
||||
exclude_patterns = ['gettingstarted/*', 'guide/layouts.rst']
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
#default_role = None
|
||||
|
|
|
@ -6,6 +6,7 @@ and why you'd want to use it.
|
|||
It goes on with a discussion of the architecture and shows you how to create
|
||||
stunning applications in short time using the framework.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
|
|
|
@ -15,7 +15,7 @@ Non-widget stuff
|
|||
|
||||
.. |atlas_text| replace:: :class:`Atlas <kivy.atlas.Atlas>` is a class for managing texture maps, i.e. packing multiple textures into one image. Using it allows you to reduce the number of images to load and speed up the application start.
|
||||
|
||||
.. |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.
|
||||
.. |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-before-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:: :meth:`~kivy.clock.ClockBase.schedule_once`
|
||||
.. |sched_intrvl| replace:: :meth:`~kivy.clock.ClockBase.schedule_interval`
|
||||
|
|
|
@ -1,5 +1,6 @@
|
|||
:orphan:
|
||||
|
||||
|
||||
Welcome to Kivy
|
||||
===============
|
||||
|
||||
|
@ -19,6 +20,28 @@ concern isn't addressed in the documentation, feel free to :ref:`contact`.
|
|||
|
||||
.. include:: contents.rst.inc
|
||||
|
||||
.. Suppress warnings about documents not being included in toc, but don't
|
||||
actually show them.
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
api-index
|
||||
api-kivy.lib.osc.OSC
|
||||
api-kivy.lib.osc.oscAPI
|
||||
.. gettingstarted/diving
|
||||
gettingstarted/drawing
|
||||
gettingstarted/events
|
||||
gettingstarted/examples
|
||||
gettingstarted/first_app
|
||||
gettingstarted/framework
|
||||
gettingstarted/installation
|
||||
gettingstarted/intro
|
||||
gettingstarted/layouts
|
||||
gettingstarted/packaging
|
||||
gettingstarted/properties
|
||||
gettingstarted/rules
|
||||
guide/layouts
|
||||
|
||||
|
||||
Appendix
|
||||
========
|
||||
|
|
|
@ -59,6 +59,8 @@ module::
|
|||
|
||||
# and keep the instance of foo, until you don't need it anymore!
|
||||
|
||||
.. _schedule-before-frame:
|
||||
|
||||
Schedule before frame
|
||||
---------------------
|
||||
|
||||
|
@ -85,6 +87,8 @@ If you need to increase the limit, set the :data:`max_iteration` property::
|
|||
from kivy.clock import Clock
|
||||
Clock.max_iteration = 20
|
||||
|
||||
.. _triggered-events:
|
||||
|
||||
Triggered Events
|
||||
----------------
|
||||
|
||||
|
|
Loading…
Reference in New Issue