Skip to content

Commit

Permalink
Update rst doc files.
Browse files Browse the repository at this point in the history
  • Loading branch information
alexlee-gk committed Jan 24, 2015
1 parent 4b4b954 commit 6c3e340
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
1 change: 1 addition & 0 deletions doc/lfd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Subpackages
lfd.registration
lfd.tpsopt
lfd.transfer
lfd.util

Class inheritance diagram
-------------------------
Expand Down
10 changes: 9 additions & 1 deletion doc/lfd.transfer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,20 @@ lfd.transfer package
Class inheritance diagram
-------------------------

.. inheritance-diagram:: lfd.transfer.registration_transfer lfd.transfer.settings lfd.transfer.transfer
.. inheritance-diagram:: lfd.transfer.planning lfd.transfer.registration_transfer lfd.transfer.settings lfd.transfer.transfer
:parts: 1

Submodules
----------

lfd.transfer.planning module
----------------------------

.. automodule:: lfd.transfer.planning
:members:
:undoc-members:
:show-inheritance:

lfd.transfer.registration_transfer module
-----------------------------------------

Expand Down
34 changes: 34 additions & 0 deletions doc/lfd.util.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
lfd.util package
================

.. automodule:: lfd.util
:members:
:undoc-members:
:show-inheritance:

Class inheritance diagram
-------------------------

.. inheritance-diagram:: lfd.util.colorize lfd.util.util
:parts: 1

Submodules
----------

lfd.util.colorize module
------------------------

.. automodule:: lfd.util.colorize
:members:
:undoc-members:
:show-inheritance:

lfd.util.util module
--------------------

.. automodule:: lfd.util.util
:members:
:undoc-members:
:show-inheritance:


0 comments on commit 6c3e340

Please sign in to comment.