Skip to content

Commit

Permalink
initial commit of bare-bones API level documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timdiller committed Feb 15, 2012
1 parent 6cdca37 commit 5617847
Show file tree
Hide file tree
Showing 54 changed files with 4,188 additions and 26 deletions.
7 changes: 7 additions & 0 deletions docs/source/api/modules.rst
@@ -0,0 +1,7 @@
pyface
======

.. toctree::
:maxdepth: 4

pyface
123 changes: 123 additions & 0 deletions docs/source/api/pyface.action.rst
@@ -0,0 +1,123 @@
action Package
==============

:mod:`action` Package
---------------------

.. automodule:: pyface.action
:members:
:undoc-members:
:show-inheritance:

:mod:`action` Module
--------------------

.. automodule:: pyface.action.action
:members:
:undoc-members:
:show-inheritance:

:mod:`action_controller` Module
-------------------------------

.. automodule:: pyface.action.action_controller
:members:
:undoc-members:
:show-inheritance:

:mod:`action_event` Module
--------------------------

.. automodule:: pyface.action.action_event
:members:
:undoc-members:
:show-inheritance:

:mod:`action_item` Module
-------------------------

.. automodule:: pyface.action.action_item
:members:
:undoc-members:
:show-inheritance:

:mod:`action_manager` Module
----------------------------

.. automodule:: pyface.action.action_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`action_manager_item` Module
---------------------------------

.. automodule:: pyface.action.action_manager_item
:members:
:undoc-members:
:show-inheritance:

:mod:`api` Module
-----------------

.. automodule:: pyface.action.api
:members:
:undoc-members:
:show-inheritance:

:mod:`group` Module
-------------------

.. automodule:: pyface.action.group
:members:
:undoc-members:
:show-inheritance:

:mod:`menu_bar_manager` Module
------------------------------

.. automodule:: pyface.action.menu_bar_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`menu_manager` Module
--------------------------

.. automodule:: pyface.action.menu_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`status_bar_manager` Module
--------------------------------

.. automodule:: pyface.action.status_bar_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`tool_bar_manager` Module
------------------------------

.. automodule:: pyface.action.tool_bar_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`tool_palette_manager` Module
----------------------------------

.. automodule:: pyface.action.tool_palette_manager
:members:
:undoc-members:
:show-inheritance:

:mod:`window_action` Module
---------------------------

.. automodule:: pyface.action.window_action
:members:
:undoc-members:
:show-inheritance:

91 changes: 91 additions & 0 deletions docs/source/api/pyface.dock.rst
@@ -0,0 +1,91 @@
dock Package
============

:mod:`dock` Package
-------------------

.. automodule:: pyface.dock
:members:
:undoc-members:
:show-inheritance:

:mod:`api` Module
-----------------

.. automodule:: pyface.dock.api
:members:
:undoc-members:
:show-inheritance:

:mod:`dock_sizer` Module
------------------------

.. automodule:: pyface.dock.dock_sizer
:members:
:undoc-members:
:show-inheritance:

:mod:`dock_window` Module
-------------------------

.. automodule:: pyface.dock.dock_window
:members:
:undoc-members:
:show-inheritance:

:mod:`dock_window_feature` Module
---------------------------------

.. automodule:: pyface.dock.dock_window_feature
:members:
:undoc-members:
:show-inheritance:

:mod:`dock_window_shell` Module
-------------------------------

.. automodule:: pyface.dock.dock_window_shell
:members:
:undoc-members:
:show-inheritance:

:mod:`feature_bar` Module
-------------------------

.. automodule:: pyface.dock.feature_bar
:members:
:undoc-members:
:show-inheritance:

:mod:`feature_tool` Module
--------------------------

.. automodule:: pyface.dock.feature_tool
:members:
:undoc-members:
:show-inheritance:

:mod:`idock_ui_provider` Module
-------------------------------

.. automodule:: pyface.dock.idock_ui_provider
:members:
:undoc-members:
:show-inheritance:

:mod:`idockable` Module
-----------------------

.. automodule:: pyface.dock.idockable
:members:
:undoc-members:
:show-inheritance:

:mod:`ifeature_tool` Module
---------------------------

.. automodule:: pyface.dock.ifeature_tool
:members:
:undoc-members:
:show-inheritance:

131 changes: 131 additions & 0 deletions docs/source/api/pyface.grid.rst
@@ -0,0 +1,131 @@
grid Package
============

:mod:`api` Module
-----------------

.. automodule:: pyface.grid.api
:members:
:undoc-members:
:show-inheritance:

:mod:`checkbox_image_renderer` Module
-------------------------------------

.. automodule:: pyface.grid.checkbox_image_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`checkbox_renderer` Module
-------------------------------

.. automodule:: pyface.grid.checkbox_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`combobox_focus_handler` Module
------------------------------------

.. automodule:: pyface.grid.combobox_focus_handler
:members:
:undoc-members:
:show-inheritance:

:mod:`composite_grid_model` Module
----------------------------------

.. automodule:: pyface.grid.composite_grid_model
:members:
:undoc-members:
:show-inheritance:

:mod:`edit_image_renderer` Module
---------------------------------

.. automodule:: pyface.grid.edit_image_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`edit_renderer` Module
---------------------------

.. automodule:: pyface.grid.edit_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`grid` Module
------------------

.. automodule:: pyface.grid.grid
:members:
:undoc-members:
:show-inheritance:

:mod:`grid_cell_image_renderer` Module
--------------------------------------

.. automodule:: pyface.grid.grid_cell_image_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`grid_cell_renderer` Module
--------------------------------

.. automodule:: pyface.grid.grid_cell_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`grid_model` Module
------------------------

.. automodule:: pyface.grid.grid_model
:members:
:undoc-members:
:show-inheritance:

:mod:`inverted_grid_model` Module
---------------------------------

.. automodule:: pyface.grid.inverted_grid_model
:members:
:undoc-members:
:show-inheritance:

:mod:`mapped_grid_cell_image_renderer` Module
---------------------------------------------

.. automodule:: pyface.grid.mapped_grid_cell_image_renderer
:members:
:undoc-members:
:show-inheritance:

:mod:`simple_grid_model` Module
-------------------------------

.. automodule:: pyface.grid.simple_grid_model
:members:
:undoc-members:
:show-inheritance:

:mod:`trait_grid_cell_adapter` Module
-------------------------------------

.. automodule:: pyface.grid.trait_grid_cell_adapter
:members:
:undoc-members:
:show-inheritance:

:mod:`trait_grid_model` Module
------------------------------

.. automodule:: pyface.grid.trait_grid_model
:members:
:undoc-members:
:show-inheritance:

43 changes: 43 additions & 0 deletions docs/source/api/pyface.preference.rst
@@ -0,0 +1,43 @@
preference Package
==================

:mod:`preference` Package
-------------------------

.. automodule:: pyface.preference
:members:
:undoc-members:
:show-inheritance:

:mod:`api` Module
-----------------

.. automodule:: pyface.preference.api
:members:
:undoc-members:
:show-inheritance:

:mod:`preference_dialog` Module
-------------------------------

.. automodule:: pyface.preference.preference_dialog
:members:
:undoc-members:
:show-inheritance:

:mod:`preference_node` Module
-----------------------------

.. automodule:: pyface.preference.preference_node
:members:
:undoc-members:
:show-inheritance:

:mod:`preference_page` Module
-----------------------------

.. automodule:: pyface.preference.preference_page
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 5617847

Please sign in to comment.