Skip to content

Commit

Permalink
enhance doc
Browse files Browse the repository at this point in the history
  • Loading branch information
brash6 committed Apr 9, 2024
1 parent 800a21f commit 3984808
Show file tree
Hide file tree
Showing 5 changed files with 135 additions and 1 deletion.
21 changes: 21 additions & 0 deletions docs/deepdespeckling.merlin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
deepdespeckling.merlin package
==============================

Submodules
----------

deepdespeckling.merlin.merlin\_denoiser module
----------------------------------------------

.. automodule:: deepdespeckling.merlin.merlin_denoiser
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: deepdespeckling.merlin
:members:
:undoc-members:
:show-inheritance:
55 changes: 55 additions & 0 deletions docs/deepdespeckling.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
deepdespeckling package
=======================

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

.. toctree::
:maxdepth: 4

deepdespeckling.merlin
deepdespeckling.sar2sar
deepdespeckling.utils

Submodules
----------

deepdespeckling.denoiser module
-------------------------------

.. automodule:: deepdespeckling.denoiser
:members:
:undoc-members:
:show-inheritance:

deepdespeckling.despeckling module
----------------------------------

.. automodule:: deepdespeckling.despeckling
:members:
:undoc-members:
:show-inheritance:

deepdespeckling.model module
----------------------------

.. automodule:: deepdespeckling.model
:members:
:undoc-members:
:show-inheritance:

deepdespeckling.test\_deepdespeckling module
--------------------------------------------

.. automodule:: deepdespeckling.test_deepdespeckling
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: deepdespeckling
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions docs/deepdespeckling.sar2sar.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
deepdespeckling.sar2sar package
===============================

Submodules
----------

deepdespeckling.sar2sar.sar2sar\_denoiser module
------------------------------------------------

.. automodule:: deepdespeckling.sar2sar.sar2sar_denoiser
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: deepdespeckling.sar2sar
:members:
:undoc-members:
:show-inheritance:
37 changes: 37 additions & 0 deletions docs/deepdespeckling.utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
deepdespeckling.utils package
=============================

Submodules
----------

deepdespeckling.utils.constants module
--------------------------------------

.. automodule:: deepdespeckling.utils.constants
:members:
:undoc-members:
:show-inheritance:

deepdespeckling.utils.load\_cosar module
----------------------------------------

.. automodule:: deepdespeckling.utils.load_cosar
:members:
:undoc-members:
:show-inheritance:

deepdespeckling.utils.utils module
----------------------------------

.. automodule:: deepdespeckling.utils.utils
:members:
:undoc-members:
:show-inheritance:

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

.. automodule:: deepdespeckling.utils
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/modules.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. toctree::
:maxdepth: 3
:maxdepth: 4
:caption: Contents:

deepdespeckling
Expand Down

0 comments on commit 3984808

Please sign in to comment.