Documentation: Move some topics to index.rst, get rid of efl.rst.
This commit is contained in:
parent
fc4f0d47ce
commit
20973afe6f
29
doc/efl.rst
29
doc/efl.rst
|
@ -1,29 +0,0 @@
|
|||
|
||||
EFL is a collection of libraries that are independent or may build on top of
|
||||
each-other to provide useful features that complement an OS's existing
|
||||
environment, rather than wrap and abstract it, trying to be their own
|
||||
environment and OS in its entirety. This means that it expects you to use
|
||||
other system libraries and API's in conjunction with EFL libraries, to provide
|
||||
a whole working application or library, simply using EFL as a set of
|
||||
convenient pre-made libraries to accomplish a whole host of complex
|
||||
or painful tasks for you.
|
||||
|
||||
One thing that has been important to EFL is efficiency. That is in both
|
||||
speed and size. The core EFL libraries even with Elementary are about half
|
||||
the size of the equivalent "small stack" of GTK+ that things like GNOME
|
||||
use. It is in the realm of one quarter the size of Qt. Of course these
|
||||
are numbers that can be argued over as to what constitutes an equivalent
|
||||
measurement. EFL is low on actual memory usage at runtime with memory
|
||||
footprints a fraction the size of those in the GTK+ and Qt worlds. In
|
||||
addition EFL is fast. For what it does. Some libraries claim to be very
|
||||
fast - but then they also don't "do much". It's easy to be fast when you
|
||||
don't tackle the more complex rendering problems involving alpha blending,
|
||||
interpolated scaling and transforms with dithering etc. EFL tackles these,
|
||||
and more.
|
||||
|
||||
.. seealso::
|
||||
|
||||
`EFL Overview <http://trac.enlightenment.org/e/wiki/EFLOverview>`_
|
||||
`EFL Documentation <http://web.enlightenment.org/p.php?p=docs>`_
|
||||
|
||||
|
|
@ -4,17 +4,6 @@
|
|||
Features
|
||||
--------
|
||||
|
||||
Logging
|
||||
^^^^^^^
|
||||
|
||||
Py-Elm provides `logging <http://docs.python.org/2/library/logging.html>`_
|
||||
to a Logger called *elementary*. It has a NullHandler by default and
|
||||
doesn't propagate so you need to add handlers to it to get output::
|
||||
|
||||
import logging
|
||||
log_from_an_elm = logging.getLogger("elementary")
|
||||
log_from_an_elm.addHandler(logging.StreamHandler())
|
||||
|
||||
Callbacks
|
||||
^^^^^^^^^
|
||||
|
||||
|
@ -37,14 +26,6 @@ Event callbacks have signature of::
|
|||
|
||||
object, source_object, event_type, event_info, *args, **kwargs
|
||||
|
||||
C API compatibility
|
||||
^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
All class properties have their respective _get/_set methods defined, for C
|
||||
API compatibility.
|
||||
|
||||
We do not document them nor encourage their use.
|
||||
|
||||
Hello Python Elementary
|
||||
-----------------------
|
||||
|
||||
|
|
|
@ -2,12 +2,71 @@
|
|||
Python Bindings for Enlightenment Foundation Libraries' documentation
|
||||
=====================================================================
|
||||
|
||||
EFL is a collection of libraries that are independent or may build on top of
|
||||
each-other to provide useful features that complement an OS's existing
|
||||
environment, rather than wrap and abstract it, trying to be their own
|
||||
environment and OS in its entirety. This means that it expects you to use
|
||||
other system libraries and API's in conjunction with EFL libraries, to provide
|
||||
a whole working application or library, simply using EFL as a set of
|
||||
convenient pre-made libraries to accomplish a whole host of complex
|
||||
or painful tasks for you.
|
||||
|
||||
.. include:: efl.rst
|
||||
One thing that has been important to EFL is efficiency. That is in both
|
||||
speed and size. The core EFL libraries even with Elementary are about half
|
||||
the size of the equivalent "small stack" of GTK+ that things like GNOME
|
||||
use. It is in the realm of one quarter the size of Qt. Of course these
|
||||
are numbers that can be argued over as to what constitutes an equivalent
|
||||
measurement. EFL is low on actual memory usage at runtime with memory
|
||||
footprints a fraction the size of those in the GTK+ and Qt worlds. In
|
||||
addition EFL is fast. For what it does. Some libraries claim to be very
|
||||
fast - but then they also don't "do much". It's easy to be fast when you
|
||||
don't tackle the more complex rendering problems involving alpha blending,
|
||||
interpolated scaling and transforms with dithering etc. EFL tackles these,
|
||||
and more.
|
||||
|
||||
.. seealso::
|
||||
|
||||
`EFL Overview <http://trac.enlightenment.org/e/wiki/EFLOverview>`_
|
||||
`EFL Documentation <http://web.enlightenment.org/p.php?p=docs>`_
|
||||
|
||||
Logging
|
||||
-------
|
||||
|
||||
PyEFL provides `logging <http://docs.python.org/2/library/logging.html>`_
|
||||
to loggers which are usually named after their equivalent module,
|
||||
f.e. *efl.eo*. There is a root logger called *efl* which also receives
|
||||
any messages coming from the underlying C libraries.
|
||||
|
||||
These loggers have a NullHandler by default and are set to log messages
|
||||
with level logging.WARNING and higher. The child loggers propagate
|
||||
messages to *efl*, which doesn't propagate to the root Python logger,
|
||||
so you need to add handlers to it to get output from it::
|
||||
|
||||
import logging
|
||||
elog = logging.getLogger("efl")
|
||||
elog.addHandler(logging.StreamHandler())
|
||||
|
||||
You should also set its level::
|
||||
|
||||
elog.setLevel(logging.INFO)
|
||||
|
||||
And you may control the child loggers individually::
|
||||
|
||||
elm_log = logging.getLogger("efl.elementary")
|
||||
elm_log.propagate = False
|
||||
elm_log.addHandler(logging.StreamHandler())
|
||||
elm_log.setLevel(logging.ERROR)
|
||||
|
||||
Class properties
|
||||
----------------
|
||||
|
||||
All class properties have their respective _get/_set methods defined.
|
||||
|
||||
These are useful when there are properties with the same name in the
|
||||
inheritance tree, or when you're using a lambda.
|
||||
|
||||
Ecore
|
||||
------------------------
|
||||
-----
|
||||
|
||||
.. toctree:: ecore/ecore
|
||||
|
||||
|
@ -38,7 +97,7 @@ Elementary
|
|||
|
||||
|
||||
DBus integration
|
||||
------------------------
|
||||
----------------
|
||||
|
||||
.. toctree:: dbus/dbus
|
||||
|
||||
|
@ -75,9 +134,3 @@ Indices and tables
|
|||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
YouTube test
|
||||
------------
|
||||
|
||||
.. youtube:: By7WohYjM50
|
||||
:width: 100%
|
||||
|
|
Loading…
Reference in New Issue