Permalink
Browse files

initial commit of bare-bones API level documentation

  • Loading branch information...
1 parent 6cdca37 commit 561784757dbad14d5753696ea21bd4539c79324f @timdiller timdiller committed Feb 15, 2012
Showing with 4,188 additions and 26 deletions.
  1. +7 −0 docs/source/api/modules.rst
  2. +123 −0 docs/source/api/pyface.action.rst
  3. +91 −0 docs/source/api/pyface.dock.rst
  4. +131 −0 docs/source/api/pyface.grid.rst
  5. +43 −0 docs/source/api/pyface.preference.rst
  6. +75 −0 docs/source/api/pyface.qt.rst
  7. +51 −0 docs/source/api/pyface.resource.rst
  8. +23 −0 docs/source/api/pyface.rst
  9. +11 −0 docs/source/api/pyface.sizers.rst
  10. +75 −0 docs/source/api/pyface.tasks.action.rst
  11. +11 −0 docs/source/api/pyface.tasks.contrib.rst
  12. +203 −0 docs/source/api/pyface.tasks.rst
  13. +27 −0 docs/source/api/pyface.timer.rst
  14. +91 −0 docs/source/api/pyface.tree.rst
  15. +67 −0 docs/source/api/pyface.ui.null.action.rst
  16. +58 −0 docs/source/api/pyface.ui.null.rst
  17. +51 −0 docs/source/api/pyface.ui.qt4.action.rst
  18. +51 −0 docs/source/api/pyface.ui.qt4.code_editor.rst
  19. +51 −0 docs/source/api/pyface.ui.qt4.console.rst
  20. +200 −0 docs/source/api/pyface.ui.qt4.rst
  21. +67 −0 docs/source/api/pyface.ui.qt4.tasks.rst
  22. +27 −0 docs/source/api/pyface.ui.qt4.timer.rst
  23. +27 −0 docs/source/api/pyface.ui.qt4.wizard.rst
  24. +43 −0 docs/source/api/pyface.ui.qt4.workbench.rst
  25. +12 −0 docs/source/api/pyface.ui.rst
  26. +67 −0 docs/source/api/pyface.ui.wx.action.rst
  27. +139 −0 docs/source/api/pyface.ui.wx.grid.rst
  28. +207 −0 docs/source/api/pyface.ui.wx.rst
  29. +27 −0 docs/source/api/pyface.ui.wx.timer.rst
  30. +27 −0 docs/source/api/pyface.ui.wx.wizard.rst
  31. +59 −0 docs/source/api/pyface.ui.wx.workbench.rst
  32. +51 −0 docs/source/api/pyface.util.rst
  33. +147 −0 docs/source/api/pyface.viewer.rst
  34. +99 −0 docs/source/api/pyface.wizard.rst
  35. +163 −0 docs/source/api/pyface.workbench.action.rst
  36. +19 −0 docs/source/api/pyface.workbench.debug.rst
  37. +187 −0 docs/source/api/pyface.workbench.rst
  38. +154 −0 docs/source/api/pyface.wx.rst
  39. +51 −0 docs/source/api/pyface.wx.spreadsheet.rst
  40. +6 −2 docs/source/conf.py
  41. +29 −24 docs/source/index.rst
  42. 0 docs/source/sphinxext/__init__.py
  43. +12 −0 docs/source/sphinxext/refactordoc/AUTHORS.txt
  44. +18 −0 docs/source/sphinxext/refactordoc/CHANGELOG.txt
  45. +28 −0 docs/source/sphinxext/refactordoc/LICENSE.txt
  46. +40 −0 docs/source/sphinxext/refactordoc/README.txt
  47. +5 −0 docs/source/sphinxext/refactordoc/TODO.txt
  48. +30 −0 docs/source/sphinxext/refactordoc/__init__.py
  49. +355 −0 docs/source/sphinxext/refactordoc/base_doc.py
  50. +107 −0 docs/source/sphinxext/refactordoc/class_doc.py
  51. +60 −0 docs/source/sphinxext/refactordoc/enaml_decl_doc.py
  52. +285 −0 docs/source/sphinxext/refactordoc/fields.py
  53. +89 −0 docs/source/sphinxext/refactordoc/function_doc.py
  54. +111 −0 docs/source/sphinxext/refactordoc/line_functions.py
@@ -0,0 +1,7 @@
+pyface
+======
+
+.. toctree::
+ :maxdepth: 4
+
+ pyface
@@ -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:
+
@@ -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:
+
@@ -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:
+
@@ -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:
+
Oops, something went wrong.

0 comments on commit 5617847

Please sign in to comment.