Skip to content

Commit

Permalink
clear up useless elements in modules reference doc
Browse files Browse the repository at this point in the history
  • Loading branch information
aperrin66 committed Apr 2, 2024
1 parent cf8c897 commit 199a4ac
Show file tree
Hide file tree
Showing 13 changed files with 60 additions and 304 deletions.
43 changes: 3 additions & 40 deletions docs/source/geospaas.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
================
geospaas package
================
========
geospaas
========

Subpackages
===========
Expand All @@ -9,44 +9,7 @@ Subpackages
:maxdepth: 1

geospaas/catalog
geospaas/export_DIF
geospaas/nansat_ingestor
geospaas/utils
geospaas/base_viewer
geospaas/vocabularies

Submodules
==========

geospaas.admin module
---------------------

.. automodule:: geospaas.admin
:members:
:undoc-members:
:show-inheritance:

geospaas.models module
----------------------

.. automodule:: geospaas.models
:members:
:undoc-members:
:show-inheritance:

geospaas.urls module
--------------------

.. automodule:: geospaas.urls
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas
:members:
:undoc-members:
:show-inheritance:
35 changes: 9 additions & 26 deletions docs/source/geospaas/base_viewer.rst
Original file line number Diff line number Diff line change
@@ -1,47 +1,30 @@
============================
geospaas.base_viewer package
============================
====================
geospaas.base_viewer
====================

Submodules
==========

geospaas.base_viewer.forms module
---------------------------------
geospaas.base_viewer.forms
--------------------------

.. automodule:: geospaas.base_viewer.forms
:members:
:undoc-members:
:show-inheritance:

geospaas.base_viewer.tests module
---------------------------------
geospaas.base_viewer.tests
--------------------------

.. automodule:: geospaas.base_viewer.tests
:members:
:undoc-members:
:show-inheritance:

geospaas.base_viewer.urls module
--------------------------------

.. automodule:: geospaas.base_viewer.urls
:members:
:undoc-members:
:show-inheritance:

geospaas.base_viewer.views module
---------------------------------
geospaas.base_viewer.views
--------------------------

.. automodule:: geospaas.base_viewer.views
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas.base_viewer
:members:
:undoc-members:
:show-inheritance:
47 changes: 7 additions & 40 deletions docs/source/geospaas/catalog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================
geospaas.catalog package
========================
================
geospaas.catalog
================

Subpackages
===========
Expand All @@ -13,51 +13,18 @@ Subpackages
Submodules
==========

geospaas.catalog.admin module
-----------------------------

.. automodule:: geospaas.catalog.admin
:members:
:undoc-members:
:show-inheritance:

geospaas.catalog.managers module
--------------------------------
geospaas.catalog.managers
-------------------------

.. automodule:: geospaas.catalog.managers
:members:
:undoc-members:
:show-inheritance:

geospaas.catalog.models module
------------------------------
geospaas.catalog.models
-----------------------

.. automodule:: geospaas.catalog.models
:members:
:undoc-members:
:show-inheritance:

geospaas.catalog.tests module
-----------------------------

.. automodule:: geospaas.catalog.tests
:members:
:undoc-members:
:show-inheritance:

geospaas.catalog.views module
-----------------------------

.. automodule:: geospaas.catalog.views
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas.catalog
:members:
:undoc-members:
:show-inheritance:
19 changes: 5 additions & 14 deletions docs/source/geospaas/catalog/management.commands.rst
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
============================================
geospaas.catalog.management.commands package
============================================
====================================
geospaas.catalog.management.commands
====================================

Submodules
==========

geospaas.catalog.management.commands.count module
-------------------------------------------------
geospaas.catalog.management.commands.count
------------------------------------------

.. automodule:: geospaas.catalog.management.commands.count
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas.catalog.management.commands
:members:
:undoc-members:
:show-inheritance:
14 changes: 3 additions & 11 deletions docs/source/geospaas/catalog/management.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
===================================
geospaas.catalog.management package
===================================
===========================
geospaas.catalog.management
===========================

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

.. toctree::

management.commands

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

.. automodule:: geospaas.catalog.management
:members:
:undoc-members:
:show-inheritance:
47 changes: 0 additions & 47 deletions docs/source/geospaas/export_DIF.rst

This file was deleted.

39 changes: 7 additions & 32 deletions docs/source/geospaas/nansat_ingestor.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
=================================
geospaas.nansat\_ingestor package
=================================
=========================
geospaas.nansat\_ingestor
=========================

Subpackages
===========
Expand All @@ -13,43 +13,18 @@ Subpackages
Submodules
==========

geospaas.nansat\_ingestor.admin module
--------------------------------------

.. automodule:: geospaas.nansat_ingestor.admin
:members:
:undoc-members:
:show-inheritance:

geospaas.nansat\_ingestor.managers module
-----------------------------------------
geospaas.nansat\_ingestor.managers
----------------------------------

.. automodule:: geospaas.nansat_ingestor.managers
:members:
:undoc-members:
:show-inheritance:

geospaas.nansat\_ingestor.models module
---------------------------------------
geospaas.nansat\_ingestor.models
--------------------------------

.. automodule:: geospaas.nansat_ingestor.models
:members:
:undoc-members:
:show-inheritance:

geospaas.nansat\_ingestor.views module
--------------------------------------

.. automodule:: geospaas.nansat_ingestor.views
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas.nansat_ingestor
:members:
:undoc-members:
:show-inheritance:
23 changes: 7 additions & 16 deletions docs/source/geospaas/nansat_ingestor/management.commands.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
=====================================================
geospaas.nansat\_ingestor.management.commands package
=====================================================
=============================================
geospaas.nansat\_ingestor.management.commands
=============================================

Submodules
==========

geospaas.nansat\_ingestor.management.commands.ingest module
-----------------------------------------------------------
geospaas.nansat\_ingestor.management.commands.ingest
----------------------------------------------------

.. automodule:: geospaas.nansat_ingestor.management.commands.ingest
:members:
:undoc-members:
:show-inheritance:

geospaas.nansat\_ingestor.management.commands.ingest\_hyrax module
------------------------------------------------------------------
geospaas.nansat\_ingestor.management.commands.ingest\_hyrax
-----------------------------------------------------------

.. automodule:: geospaas.nansat_ingestor.management.commands.ingest_hyrax
:members:
:undoc-members:
:show-inheritance:


Module contents
===============

.. automodule:: geospaas.nansat_ingestor.management.commands
:members:
:undoc-members:
:show-inheritance:
14 changes: 3 additions & 11 deletions docs/source/geospaas/nansat_ingestor/management.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
============================================
geospaas.nansat\_ingestor.management package
============================================
====================================
geospaas.nansat\_ingestor.management
====================================

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

.. toctree::

management.commands

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

.. automodule:: geospaas.nansat_ingestor.management
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 199a4ac

Please sign in to comment.