Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor doc fix #95

Merged
merged 2 commits into from Feb 24, 2014
Merged

minor doc fix #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
780edc1
add links to the online documentation to the README file so the docs …
timdiller Dec 11, 2013
1fa1322
rerun sphinx-apidoc
timdiller Dec 11, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.rst
View file
Open in desktop
Expand Up @@ -14,6 +14,10 @@ The following GUI backends are supported:
- PyQt
- PySide

Documentation
-------------
`Online Documentation <http://docs.enthought.com/pyface/>`_.
`API Documentation <http://docs.enthought.com/pyface/api/pyface.html>`_.

Prerequisites
-------------
Expand Down
1 change: 1 addition & 0 deletions docs/source/api/pyface.rst
View file
Open in desktop
Expand Up @@ -12,6 +12,7 @@ pyface Package
pyface.resource
pyface.sizers
pyface.tasks
pyface.tests
pyface.timer
pyface.tree
pyface.ui
Expand Down
16 changes: 16 additions & 0 deletions docs/source/api/pyface.tasks.rst
View file
Open in desktop
Expand Up @@ -57,6 +57,14 @@ tasks Package
:undoc-members:
:show-inheritance:

:mod:`enaml_pane` Module
------------------------

.. automodule:: pyface.tasks.enaml_pane
:members:
:undoc-members:
:show-inheritance:

:mod:`enaml_task_pane` Module
-----------------------------

Expand Down Expand Up @@ -113,6 +121,14 @@ tasks Package
:undoc-members:
:show-inheritance:

:mod:`split_editor_area_pane` Module
------------------------------------

.. automodule:: pyface.tasks.split_editor_area_pane
:members:
:undoc-members:
:show-inheritance:

:mod:`task` Module
------------------

Expand Down
11 changes: 11 additions & 0 deletions docs/source/api/pyface.tests.rst
View file
Open in desktop
@@ -0,0 +1,11 @@
tests Package
=============

:mod:`test_splash_screen_log_handler` Module
--------------------------------------------

.. automodule:: pyface.tests.test_splash_screen_log_handler
:members:
:undoc-members:
:show-inheritance:

9 changes: 9 additions & 0 deletions docs/source/api/pyface.ui.qt4.rst
View file
Open in desktop
Expand Up @@ -25,6 +25,14 @@ qt4 Package
:undoc-members:
:show-inheritance:

:mod:`beep` Module
------------------

.. automodule:: pyface.ui.qt4.beep
:members:
:undoc-members:
:show-inheritance:

:mod:`clipboard` Module
-----------------------

Expand Down Expand Up @@ -195,6 +203,7 @@ Subpackages
pyface.ui.qt4.console
pyface.ui.qt4.tasks
pyface.ui.qt4.timer
pyface.ui.qt4.util
pyface.ui.qt4.wizard
pyface.ui.qt4.workbench

8 changes: 8 additions & 0 deletions docs/source/api/pyface.ui.qt4.tasks.rst
View file
Open in desktop
Expand Up @@ -41,6 +41,14 @@ tasks Package
:undoc-members:
:show-inheritance:

:mod:`split_editor_area_pane` Module
------------------------------------

.. automodule:: pyface.ui.qt4.tasks.split_editor_area_pane
:members:
:undoc-members:
:show-inheritance:

:mod:`task_pane` Module
-----------------------

Expand Down
11 changes: 11 additions & 0 deletions docs/source/api/pyface.ui.qt4.util.rst
View file
Open in desktop
@@ -0,0 +1,11 @@
util Package
============

:mod:`testing` Module
---------------------

.. automodule:: pyface.ui.qt4.util.testing
:members:
:undoc-members:
:show-inheritance:

15 changes: 11 additions & 4 deletions docs/source/api/pyface.ui.wx.rst
View file
Open in desktop
Expand Up @@ -25,6 +25,14 @@ wx Package
:undoc-members:
:show-inheritance:

:mod:`beep` Module
------------------

.. automodule:: pyface.ui.wx.beep
:members:
:undoc-members:
:show-inheritance:

:mod:`clipboard` Module
-----------------------

Expand Down Expand Up @@ -105,11 +113,10 @@ wx Package
:undoc-members:
:show-inheritance:

..
:mod:`ipython_widget` Module
----------------------------
:mod:`ipython_widget` Module
----------------------------

.. automodule:: pyface.ui.wx.ipython_widget
.. automodule:: pyface.ui.wx.ipython_widget
:members:
:undoc-members:
:show-inheritance:
Expand Down
51 changes: 51 additions & 0 deletions docs/source/api/pyface.util.grid.rst
View file
Open in desktop
@@ -0,0 +1,51 @@
grid Package
============

:mod:`grid` Package
-------------------

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

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

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

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

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

:mod:`grid_column` Module
-------------------------

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

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

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

:mod:`grid_row` Module
----------------------

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

18 changes: 13 additions & 5 deletions docs/source/api/pyface.util.rst
View file
Open in desktop
Expand Up @@ -33,6 +33,14 @@ util Package
:undoc-members:
:show-inheritance:

:mod:`id_helper` Module
-----------------------

.. automodule:: pyface.util.id_helper
:members:
:undoc-members:
:show-inheritance:

:mod:`python_stc` Module
------------------------

Expand All @@ -41,11 +49,11 @@ util Package
:undoc-members:
:show-inheritance:

..
Subpackages
-----------
Subpackages
-----------

.. toctree::
.. toctree::

pyface.util.grid
pyface.util.grid
pyface.util.tests

11 changes: 11 additions & 0 deletions docs/source/api/pyface.util.tests.rst
View file
Open in desktop
@@ -0,0 +1,11 @@
tests Package
=============

:mod:`test_id_helper` Module
----------------------------

.. automodule:: pyface.util.tests.test_id_helper
:members:
:undoc-members:
:show-inheritance: