Skip to content

Commit

Permalink
Added module files to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TomSlater committed Dec 4, 2020
1 parent b277b91 commit 141b1da
Show file tree
Hide file tree
Showing 4 changed files with 133 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/source/epsic_tools.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
epsic\_tools package
====================

Subpackages
-----------

.. toctree::

epsic_tools.signals
epsic_tools.toolbox

Submodules
----------

epsic\_tools.api module
-----------------------

.. automodule:: epsic_tools.api
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.build\_params module
---------------------------------

.. automodule:: epsic_tools.build_params
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.ptychography2D module
----------------------------------

.. automodule:: epsic_tools.ptychography2D
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: epsic_tools
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/source/epsic_tools.signals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
epsic\_tools.signals package
============================

Module contents
---------------

.. automodule:: epsic_tools.signals
:members:
:undoc-members:
:show-inheritance:
70 changes: 70 additions & 0 deletions docs/source/epsic_tools.toolbox.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
epsic\_tools.toolbox package
============================

Submodules
----------

epsic\_tools.toolbox.define\_probe\_function module
---------------------------------------------------

.. automodule:: epsic_tools.toolbox.define_probe_function
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.make\_merlin\_mask module
----------------------------------------------

.. automodule:: epsic_tools.toolbox.make_merlin_mask
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.make\_merlin\_mask\_test module
----------------------------------------------------

.. automodule:: epsic_tools.toolbox.make_merlin_mask_test
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.ptycho\_utils module
-----------------------------------------

.. automodule:: epsic_tools.toolbox.ptycho_utils
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.radial\_profile module
-------------------------------------------

.. automodule:: epsic_tools.toolbox.radial_profile
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.sim\_utils module
--------------------------------------

.. automodule:: epsic_tools.toolbox.sim_utils
:members:
:undoc-members:
:show-inheritance:

epsic\_tools.toolbox.warp\_3d module
------------------------------------

.. automodule:: epsic_tools.toolbox.warp_3d
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: epsic_tools.toolbox
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
epsic_tools
===========

.. toctree::
:maxdepth: 4

epsic_tools

0 comments on commit 141b1da

Please sign in to comment.