davemds pushed a commit to branch master.
http://git.enlightenment.org/bindings/python/python-efl.git/commit/?id=afc49ca5956c0af157bbb0e1f592557790f500f9
commit afc49ca5956c0af157bbb0e1f592557790f500f9
Author: Dave Andreoli <d...@gurumeditation.it>
Date: Fri Jan 9 21:17:02 2015 +0100
Doc: restructure elementary documentation
---
.../{module-actionslider.rst => actionslider.rst} | 0
.../{module-background.rst => background.rst} | 0
doc/elementary/{module-box.rst => box.rst} | 0
doc/elementary/{module-bubble.rst => bubble.rst} | 0
doc/elementary/{module-button.rst => button.rst} | 0
.../{module-calendar.rst => calendar.rst} | 0
doc/elementary/{module-check.rst => check.rst} | 0
doc/elementary/{module-clock.rst => clock.rst} | 0
...{module-colorselector.rst => colorselector.rst} | 0
...{module-configuration.rst => configuration.rst} | 0
.../{module-conformant.rst => conformant.rst} | 0
.../{module-ctxpopup.rst => ctxpopup.rst} | 0
.../{module-datetime.rst => datetime.rst} | 0
.../{module-dayselector.rst => dayselector.rst} | 0
.../{module-diskselector.rst => diskselector.rst} | 0
doc/elementary/elementary.rst | 191 ++++++++++-----------
doc/elementary/elementary_module.rst | 5 +
doc/elementary/{module-entry.rst => entry.rst} | 0
.../{module-fileselector.rst => fileselector.rst} | 0
...selector_button.rst => fileselector_button.rst} | 0
...leselector_entry.rst => fileselector_entry.rst} | 0
doc/elementary/{module-flip.rst => flip.rst} | 0
.../{module-flipselector.rst => flipselector.rst} | 0
doc/elementary/{module-frame.rst => frame.rst} | 0
doc/elementary/{module-general.rst => general.rst} | 0
doc/elementary/{module-gengrid.rst => gengrid.rst} | 0
doc/elementary/{module-genlist.rst => genlist.rst} | 0
...{module-gesture_layer.rst => gesture_layer.rst} | 0
doc/elementary/{module-grid.rst => grid.rst} | 0
doc/elementary/{module-hover.rst => hover.rst} | 0
.../{module-hoversel.rst => hoversel.rst} | 0
doc/elementary/{module-icon.rst => icon.rst} | 0
doc/elementary/{module-image.rst => image.rst} | 0
doc/elementary/{module-index.rst => index.rst} | 0
.../{module-innerwindow.rst => innerwindow.rst} | 0
doc/elementary/{module-label.rst => label.rst} | 0
doc/elementary/{module-layout.rst => layout.rst} | 0
.../{module-layout_class.rst => layout_class.rst} | 0
doc/elementary/{module-list.rst => list.rst} | 0
doc/elementary/{module-map.rst => map.rst} | 0
doc/elementary/{module-mapbuf.rst => mapbuf.rst} | 0
doc/elementary/{module-menu.rst => menu.rst} | 0
...e-multibuttonentry.rst => multibuttonentry.rst} | 0
.../{module-naviframe.rst => naviframe.rst} | 0
doc/elementary/{module-need.rst => need.rst} | 0
doc/elementary/{module-notify.rst => notify.rst} | 0
doc/elementary/{module-object.rst => object.rst} | 0
.../{module-object_item.rst => object_item.rst} | 0
doc/elementary/{module-panel.rst => panel.rst} | 0
doc/elementary/{module-panes.rst => panes.rst} | 0
doc/elementary/{module-photo.rst => photo.rst} | 0
.../{module-photocam.rst => photocam.rst} | 0
doc/elementary/{module-plug.rst => plug.rst} | 0
doc/elementary/{module-popup.rst => popup.rst} | 0
.../{module-progressbar.rst => progressbar.rst} | 0
doc/elementary/{module-radio.rst => radio.rst} | 0
.../{module-scroller.rst => scroller.rst} | 0
...ule-segment_control.rst => segment_control.rst} | 0
.../{module-separator.rst => separator.rst} | 0
doc/elementary/{module-slider.rst => slider.rst} | 0
.../{module-slideshow.rst => slideshow.rst} | 0
doc/elementary/{module-spinner.rst => spinner.rst} | 0
doc/elementary/{module-table.rst => table.rst} | 0
doc/elementary/{module-theme.rst => theme.rst} | 0
doc/elementary/{module-thumb.rst => thumb.rst} | 0
doc/elementary/{module-toolbar.rst => toolbar.rst} | 0
doc/elementary/{module-transit.rst => transit.rst} | 0
doc/elementary/{module-video.rst => video.rst} | 0
doc/elementary/{module-web.rst => web.rst} | 0
doc/elementary/{module-window.rst => window.rst} | 0
doc/emotion/emotion.rst | 4 +-
doc/index.rst | 4 +-
72 files changed, 101 insertions(+), 103 deletions(-)
diff --git a/doc/elementary/module-actionslider.rst
b/doc/elementary/actionslider.rst
similarity index 100%
rename from doc/elementary/module-actionslider.rst
rename to doc/elementary/actionslider.rst
diff --git a/doc/elementary/module-background.rst
b/doc/elementary/background.rst
similarity index 100%
rename from doc/elementary/module-background.rst
rename to doc/elementary/background.rst
diff --git a/doc/elementary/module-box.rst b/doc/elementary/box.rst
similarity index 100%
rename from doc/elementary/module-box.rst
rename to doc/elementary/box.rst
diff --git a/doc/elementary/module-bubble.rst b/doc/elementary/bubble.rst
similarity index 100%
rename from doc/elementary/module-bubble.rst
rename to doc/elementary/bubble.rst
diff --git a/doc/elementary/module-button.rst b/doc/elementary/button.rst
similarity index 100%
rename from doc/elementary/module-button.rst
rename to doc/elementary/button.rst
diff --git a/doc/elementary/module-calendar.rst b/doc/elementary/calendar.rst
similarity index 100%
rename from doc/elementary/module-calendar.rst
rename to doc/elementary/calendar.rst
diff --git a/doc/elementary/module-check.rst b/doc/elementary/check.rst
similarity index 100%
rename from doc/elementary/module-check.rst
rename to doc/elementary/check.rst
diff --git a/doc/elementary/module-clock.rst b/doc/elementary/clock.rst
similarity index 100%
rename from doc/elementary/module-clock.rst
rename to doc/elementary/clock.rst
diff --git a/doc/elementary/module-colorselector.rst
b/doc/elementary/colorselector.rst
similarity index 100%
rename from doc/elementary/module-colorselector.rst
rename to doc/elementary/colorselector.rst
diff --git a/doc/elementary/module-configuration.rst
b/doc/elementary/configuration.rst
similarity index 100%
rename from doc/elementary/module-configuration.rst
rename to doc/elementary/configuration.rst
diff --git a/doc/elementary/module-conformant.rst
b/doc/elementary/conformant.rst
similarity index 100%
rename from doc/elementary/module-conformant.rst
rename to doc/elementary/conformant.rst
diff --git a/doc/elementary/module-ctxpopup.rst b/doc/elementary/ctxpopup.rst
similarity index 100%
rename from doc/elementary/module-ctxpopup.rst
rename to doc/elementary/ctxpopup.rst
diff --git a/doc/elementary/module-datetime.rst b/doc/elementary/datetime.rst
similarity index 100%
rename from doc/elementary/module-datetime.rst
rename to doc/elementary/datetime.rst
diff --git a/doc/elementary/module-dayselector.rst
b/doc/elementary/dayselector.rst
similarity index 100%
rename from doc/elementary/module-dayselector.rst
rename to doc/elementary/dayselector.rst
diff --git a/doc/elementary/module-diskselector.rst
b/doc/elementary/diskselector.rst
similarity index 100%
rename from doc/elementary/module-diskselector.rst
rename to doc/elementary/diskselector.rst
diff --git a/doc/elementary/elementary.rst b/doc/elementary/elementary.rst
index 836b009..a874d8c 100644
--- a/doc/elementary/elementary.rst
+++ b/doc/elementary/elementary.rst
@@ -1,15 +1,22 @@
-.. py:module:: efl.elementary
-:mod:`efl.elementary` Package
-=============================
-Features
---------
+What is Elementary?
+-------------------
+
+Elementary is a the high level toolkit based on the underlying efl
+technologies (:doc:`Evas </evas/evas>`, :doc:`Edje </edje/edje>`,
+:doc:`Ecore </ecore/ecore>`, etc...). It provide all the
+widget you need to build a full application.
+
+It is meant to make the programmers work almost brainless but give them lots
+of flexibility.
+
Callbacks
-^^^^^^^^^
+---------
-.. rubric:: Widget callbacks
+Widget callbacks
+^^^^^^^^^^^^^^^^
Widget callbacks are set with callback_*_add methods which take a callable,
and optional args, kwargs as data.
@@ -22,113 +29,99 @@ or::
obj, event_info, *args, **kwargs
-.. rubric:: Event callbacks
+
+Event callbacks
+^^^^^^^^^^^^^^^
Event callbacks have signature of::
object, source_object, event_type, event_info, *args, **kwargs
+
A sample Python Elementary program
----------------------------------
.. literalinclude:: ../../examples/elementary/test_win_dialog.py
:language: python
-What is Elementary?
--------------------
-
-Elementary is a the high level toolkit based on the underlying efl
-technologies (:doc:`Evas </evas/evas>`, :doc:`Edje </edje/edje>`,
-:doc:`Ecore </ecore/ecore>`, etc...). It provide all the
-widget you need to build a full application.
-
-It is meant to make the programmers work almost brainless but give them lots
-of flexibility.
-Reference
----------
-
-Package
-^^^^^^^
-
-Everything in the modules :py:mod:`~efl.elementary.general` and
-:py:mod:`~efl.elementary.need` is also available at package level.
-
-Modules
-^^^^^^^
+API Reference
+-------------
.. toctree::
- :maxdepth: 4
-
- module-actionslider
- module-background
- module-box
- module-bubble
- module-button
- module-calendar
- module-check
- module-clock
- module-colorselector
- module-configuration
- module-conformant
- module-ctxpopup
- module-datetime
- module-dayselector
- module-diskselector
- module-entry
- module-fileselector
- module-fileselector_button
- module-fileselector_entry
- module-flip
- module-flipselector
- module-frame
- module-general
- module-gengrid
- module-genlist
- module-gesture_layer
- module-grid
- module-hover
- module-hoversel
- module-icon
- module-image
- module-index
- module-innerwindow
- module-label
- module-layout
- module-layout_class
- module-list
- module-map
- module-mapbuf
- module-menu
- module-multibuttonentry
- module-naviframe
- module-need
- module-notify
- module-object
- module-object_item
- module-panel
- module-panes
- module-photo
- module-photocam
- module-plug
- module-popup
- module-progressbar
- module-radio
- module-scroller
- module-segment_control
- module-separator
- module-slider
- module-slideshow
- module-spinner
- module-table
- module-theme
- module-thumb
- module-toolbar
- module-transit
- module-video
- module-web
- module-window
+ :maxdepth: 1
+
+ elementary_module
+ actionslider
+ background
+ box
+ bubble
+ button
+ calendar
+ check
+ clock
+ colorselector
+ configuration
+ conformant
+ ctxpopup
+ datetime
+ dayselector
+ diskselector
+ entry
+ fileselector
+ fileselector_button
+ fileselector_entry
+ flip
+ flipselector
+ frame
+ general
+ gengrid
+ genlist
+ gesture_layer
+ grid
+ hover
+ hoversel
+ icon
+ image
+ index
+ innerwindow
+ label
+ layout
+ layout_class
+ list
+ map
+ mapbuf
+ menu
+ multibuttonentry
+ naviframe
+ need
+ notify
+ object
+ object_item
+ panel
+ panes
+ photo
+ photocam
+ plug
+ popup
+ progressbar
+ radio
+ scroller
+ segment_control
+ separator
+ slider
+ slideshow
+ spinner
+ table
+ theme
+ thumb
+ toolbar
+ transit
+ video
+ web
+ window
+
Inheritance diagram
-------------------
diff --git a/doc/elementary/elementary_module.rst
b/doc/elementary/elementary_module.rst
new file mode 100644
index 0000000..10d89de
--- /dev/null
+++ b/doc/elementary/elementary_module.rst
@@ -0,0 +1,5 @@
+:mod:`efl.elementary` Package
+=============================
+
+.. automodule:: efl.elementary
+ :exclude-members: ActionSlider
diff --git a/doc/elementary/module-entry.rst b/doc/elementary/entry.rst
similarity index 100%
rename from doc/elementary/module-entry.rst
rename to doc/elementary/entry.rst
diff --git a/doc/elementary/module-fileselector.rst
b/doc/elementary/fileselector.rst
similarity index 100%
rename from doc/elementary/module-fileselector.rst
rename to doc/elementary/fileselector.rst
diff --git a/doc/elementary/module-fileselector_button.rst
b/doc/elementary/fileselector_button.rst
similarity index 100%
rename from doc/elementary/module-fileselector_button.rst
rename to doc/elementary/fileselector_button.rst
diff --git a/doc/elementary/module-fileselector_entry.rst
b/doc/elementary/fileselector_entry.rst
similarity index 100%
rename from doc/elementary/module-fileselector_entry.rst
rename to doc/elementary/fileselector_entry.rst
diff --git a/doc/elementary/module-flip.rst b/doc/elementary/flip.rst
similarity index 100%
rename from doc/elementary/module-flip.rst
rename to doc/elementary/flip.rst
diff --git a/doc/elementary/module-flipselector.rst
b/doc/elementary/flipselector.rst
similarity index 100%
rename from doc/elementary/module-flipselector.rst
rename to doc/elementary/flipselector.rst
diff --git a/doc/elementary/module-frame.rst b/doc/elementary/frame.rst
similarity index 100%
rename from doc/elementary/module-frame.rst
rename to doc/elementary/frame.rst
diff --git a/doc/elementary/module-general.rst b/doc/elementary/general.rst
similarity index 100%
rename from doc/elementary/module-general.rst
rename to doc/elementary/general.rst
diff --git a/doc/elementary/module-gengrid.rst b/doc/elementary/gengrid.rst
similarity index 100%
rename from doc/elementary/module-gengrid.rst
rename to doc/elementary/gengrid.rst
diff --git a/doc/elementary/module-genlist.rst b/doc/elementary/genlist.rst
similarity index 100%
rename from doc/elementary/module-genlist.rst
rename to doc/elementary/genlist.rst
diff --git a/doc/elementary/module-gesture_layer.rst
b/doc/elementary/gesture_layer.rst
similarity index 100%
rename from doc/elementary/module-gesture_layer.rst
rename to doc/elementary/gesture_layer.rst
diff --git a/doc/elementary/module-grid.rst b/doc/elementary/grid.rst
similarity index 100%
rename from doc/elementary/module-grid.rst
rename to doc/elementary/grid.rst
diff --git a/doc/elementary/module-hover.rst b/doc/elementary/hover.rst
similarity index 100%
rename from doc/elementary/module-hover.rst
rename to doc/elementary/hover.rst
diff --git a/doc/elementary/module-hoversel.rst b/doc/elementary/hoversel.rst
similarity index 100%
rename from doc/elementary/module-hoversel.rst
rename to doc/elementary/hoversel.rst
diff --git a/doc/elementary/module-icon.rst b/doc/elementary/icon.rst
similarity index 100%
rename from doc/elementary/module-icon.rst
rename to doc/elementary/icon.rst
diff --git a/doc/elementary/module-image.rst b/doc/elementary/image.rst
similarity index 100%
rename from doc/elementary/module-image.rst
rename to doc/elementary/image.rst
diff --git a/doc/elementary/module-index.rst b/doc/elementary/index.rst
similarity index 100%
rename from doc/elementary/module-index.rst
rename to doc/elementary/index.rst
diff --git a/doc/elementary/module-innerwindow.rst
b/doc/elementary/innerwindow.rst
similarity index 100%
rename from doc/elementary/module-innerwindow.rst
rename to doc/elementary/innerwindow.rst
diff --git a/doc/elementary/module-label.rst b/doc/elementary/label.rst
similarity index 100%
rename from doc/elementary/module-label.rst
rename to doc/elementary/label.rst
diff --git a/doc/elementary/module-layout.rst b/doc/elementary/layout.rst
similarity index 100%
rename from doc/elementary/module-layout.rst
rename to doc/elementary/layout.rst
diff --git a/doc/elementary/module-layout_class.rst
b/doc/elementary/layout_class.rst
similarity index 100%
rename from doc/elementary/module-layout_class.rst
rename to doc/elementary/layout_class.rst
diff --git a/doc/elementary/module-list.rst b/doc/elementary/list.rst
similarity index 100%
rename from doc/elementary/module-list.rst
rename to doc/elementary/list.rst
diff --git a/doc/elementary/module-map.rst b/doc/elementary/map.rst
similarity index 100%
rename from doc/elementary/module-map.rst
rename to doc/elementary/map.rst
diff --git a/doc/elementary/module-mapbuf.rst b/doc/elementary/mapbuf.rst
similarity index 100%
rename from doc/elementary/module-mapbuf.rst
rename to doc/elementary/mapbuf.rst
diff --git a/doc/elementary/module-menu.rst b/doc/elementary/menu.rst
similarity index 100%
rename from doc/elementary/module-menu.rst
rename to doc/elementary/menu.rst
diff --git a/doc/elementary/module-multibuttonentry.rst
b/doc/elementary/multibuttonentry.rst
similarity index 100%
rename from doc/elementary/module-multibuttonentry.rst
rename to doc/elementary/multibuttonentry.rst
diff --git a/doc/elementary/module-naviframe.rst b/doc/elementary/naviframe.rst
similarity index 100%
rename from doc/elementary/module-naviframe.rst
rename to doc/elementary/naviframe.rst
diff --git a/doc/elementary/module-need.rst b/doc/elementary/need.rst
similarity index 100%
rename from doc/elementary/module-need.rst
rename to doc/elementary/need.rst
diff --git a/doc/elementary/module-notify.rst b/doc/elementary/notify.rst
similarity index 100%
rename from doc/elementary/module-notify.rst
rename to doc/elementary/notify.rst
diff --git a/doc/elementary/module-object.rst b/doc/elementary/object.rst
similarity index 100%
rename from doc/elementary/module-object.rst
rename to doc/elementary/object.rst
diff --git a/doc/elementary/module-object_item.rst
b/doc/elementary/object_item.rst
similarity index 100%
rename from doc/elementary/module-object_item.rst
rename to doc/elementary/object_item.rst
diff --git a/doc/elementary/module-panel.rst b/doc/elementary/panel.rst
similarity index 100%
rename from doc/elementary/module-panel.rst
rename to doc/elementary/panel.rst
diff --git a/doc/elementary/module-panes.rst b/doc/elementary/panes.rst
similarity index 100%
rename from doc/elementary/module-panes.rst
rename to doc/elementary/panes.rst
diff --git a/doc/elementary/module-photo.rst b/doc/elementary/photo.rst
similarity index 100%
rename from doc/elementary/module-photo.rst
rename to doc/elementary/photo.rst
diff --git a/doc/elementary/module-photocam.rst b/doc/elementary/photocam.rst
similarity index 100%
rename from doc/elementary/module-photocam.rst
rename to doc/elementary/photocam.rst
diff --git a/doc/elementary/module-plug.rst b/doc/elementary/plug.rst
similarity index 100%
rename from doc/elementary/module-plug.rst
rename to doc/elementary/plug.rst
diff --git a/doc/elementary/module-popup.rst b/doc/elementary/popup.rst
similarity index 100%
rename from doc/elementary/module-popup.rst
rename to doc/elementary/popup.rst
diff --git a/doc/elementary/module-progressbar.rst
b/doc/elementary/progressbar.rst
similarity index 100%
rename from doc/elementary/module-progressbar.rst
rename to doc/elementary/progressbar.rst
diff --git a/doc/elementary/module-radio.rst b/doc/elementary/radio.rst
similarity index 100%
rename from doc/elementary/module-radio.rst
rename to doc/elementary/radio.rst
diff --git a/doc/elementary/module-scroller.rst b/doc/elementary/scroller.rst
similarity index 100%
rename from doc/elementary/module-scroller.rst
rename to doc/elementary/scroller.rst
diff --git a/doc/elementary/module-segment_control.rst
b/doc/elementary/segment_control.rst
similarity index 100%
rename from doc/elementary/module-segment_control.rst
rename to doc/elementary/segment_control.rst
diff --git a/doc/elementary/module-separator.rst b/doc/elementary/separator.rst
similarity index 100%
rename from doc/elementary/module-separator.rst
rename to doc/elementary/separator.rst
diff --git a/doc/elementary/module-slider.rst b/doc/elementary/slider.rst
similarity index 100%
rename from doc/elementary/module-slider.rst
rename to doc/elementary/slider.rst
diff --git a/doc/elementary/module-slideshow.rst b/doc/elementary/slideshow.rst
similarity index 100%
rename from doc/elementary/module-slideshow.rst
rename to doc/elementary/slideshow.rst
diff --git a/doc/elementary/module-spinner.rst b/doc/elementary/spinner.rst
similarity index 100%
rename from doc/elementary/module-spinner.rst
rename to doc/elementary/spinner.rst
diff --git a/doc/elementary/module-table.rst b/doc/elementary/table.rst
similarity index 100%
rename from doc/elementary/module-table.rst
rename to doc/elementary/table.rst
diff --git a/doc/elementary/module-theme.rst b/doc/elementary/theme.rst
similarity index 100%
rename from doc/elementary/module-theme.rst
rename to doc/elementary/theme.rst
diff --git a/doc/elementary/module-thumb.rst b/doc/elementary/thumb.rst
similarity index 100%
rename from doc/elementary/module-thumb.rst
rename to doc/elementary/thumb.rst
diff --git a/doc/elementary/module-toolbar.rst b/doc/elementary/toolbar.rst
similarity index 100%
rename from doc/elementary/module-toolbar.rst
rename to doc/elementary/toolbar.rst
diff --git a/doc/elementary/module-transit.rst b/doc/elementary/transit.rst
similarity index 100%
rename from doc/elementary/module-transit.rst
rename to doc/elementary/transit.rst
diff --git a/doc/elementary/module-video.rst b/doc/elementary/video.rst
similarity index 100%
rename from doc/elementary/module-video.rst
rename to doc/elementary/video.rst
diff --git a/doc/elementary/module-web.rst b/doc/elementary/web.rst
similarity index 100%
rename from doc/elementary/module-web.rst
rename to doc/elementary/web.rst
diff --git a/doc/elementary/module-window.rst b/doc/elementary/window.rst
similarity index 100%
rename from doc/elementary/module-window.rst
rename to doc/elementary/window.rst
diff --git a/doc/emotion/emotion.rst b/doc/emotion/emotion.rst
index b2714be..36bd158 100644
--- a/doc/emotion/emotion.rst
+++ b/doc/emotion/emotion.rst
@@ -76,8 +76,8 @@ a list of interesting signals:
- ``position_load,failed``
-Reference
----------
+API Reference
+-------------
.. toctree::
:maxdepth: 4
diff --git a/doc/index.rst b/doc/index.rst
index 0f9c537..a09b701 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -75,8 +75,8 @@ Emotion
Elementary
----------
-.. toctree:: elementary/elementary
- :maxdepth: 4
+.. toctree:: elementary/elementary.rst
+ :maxdepth: 2
DBus integration
--
