Skip to content

Commit

Permalink
Working autodoc components
Browse files Browse the repository at this point in the history
  • Loading branch information
nickrsan committed Sep 20, 2023
1 parent 97f115a commit 5b2e89d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 17 deletions.
7 changes: 4 additions & 3 deletions docs/source/api_reference/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
.. _api:

====
API
====
========================
EEDL Full API Reference
========================

.. automodule:: eedl
:members:
:undoc-members:
:show-inheritance:
:no-index:
18 changes: 5 additions & 13 deletions docs/source/eedl.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
eedl package
============
EEDL Full API Reference
=========================

Submodules
----------

eedl.google\_cloud module
-------------------------

.. automodule:: eedl.google_cloud
:members:
:undoc-members:
:show-inheritance:

eedl.image module
-----------------

Expand Down Expand Up @@ -44,10 +36,10 @@ eedl.zonal module
:undoc-members:
:show-inheritance:

Module contents
---------------
eedl.google\_cloud module
-------------------------

.. automodule:: eedl
.. automodule:: eedl.google_cloud
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to the documentation for your project. This is the main index page.

user_guide/index
examples/index
api_reference/index
eedl

Indices and tables
==================
Expand Down

0 comments on commit 5b2e89d

Please sign in to comment.