update doc structure

nansencenter · Mar 22, 2024 · 1c248f6 · 1c248f6
1 parent e23ba7f
commit 1c248f6
Show file tree

Hide file tree

Showing 22 changed files with 63 additions and 171 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,7 +6,10 @@
 Welcome to django-geo-spaas's documentation!
 ============================================
 
-Contents:
+GeoSPaaS is a set of Python tools meant to help scientists deal with Earth Observation data.
+django-geo-spaas is the core of GeoSPaaS. It is composed of several
+`GeoDjango <https://docs.djangoproject.com/en/5.0/ref/contrib/gis/>`_ apps which provide basic
+functionalities
 
 .. toctree::
    :maxdepth: 2
@@ -15,11 +18,8 @@ Contents:
    :maxdepth: 1
    :caption: User documentation
 
-..
    source/installation.rst
    source/tutorials.rst
-   source/packages_and_modules.rst
-   source/acknowledgments.rst
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/geospaas.catalog.migrations.rst b/docs/source/geospaas.catalog.migrations.rst
diff --git a/docs/source/geospaas.export_DIF.migrations.rst b/docs/source/geospaas.export_DIF.migrations.rst
diff --git a/docs/source/geospaas.nansat_ingestor.migrations.rst b/docs/source/geospaas.nansat_ingestor.migrations.rst
diff --git a/docs/source/geospaas.nansat_ingestor.tests.rst b/docs/source/geospaas.nansat_ingestor.tests.rst
diff --git a/docs/source/geospaas.rst b/docs/source/geospaas.rst
@@ -1,20 +1,21 @@
+================
 geospaas package
 ================
 
 Subpackages
------------
+===========
 
 .. toctree::
 
-    geospaas.catalog
-    geospaas.export_DIF
-    geospaas.nansat_ingestor
-    geospaas.utils
-    geospaas.base_viewer
-    geospaas.vocabularies
+    geospaas/catalog
+    geospaas/export_DIF
+    geospaas/nansat_ingestor
+    geospaas/utils
+    geospaas/base_viewer
+    geospaas/vocabularies
 
 Submodules
-----------
+==========
 
 geospaas.admin module
 ---------------------
@@ -42,7 +43,7 @@ geospaas.urls module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas
     :members:

diff --git a/docs/source/geospaas.vocabularies.migrations.rst b/docs/source/geospaas.vocabularies.migrations.rst
diff --git a/docs/source/geospaas.base_viewer.rst → docs/source/geospaas/base_viewer.rst b/docs/source/geospaas.base_viewer.rst → docs/source/geospaas/base_viewer.rst
@@ -1,8 +1,9 @@
+============================
 geospaas.base_viewer package
 ============================
 
 Submodules
-----------
+==========
 
 geospaas.base_viewer.forms module
 ---------------------------------
@@ -38,7 +39,7 @@ geospaas.base_viewer.views module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.base_viewer
     :members:

diff --git a/docs/source/geospaas.catalog.rst → docs/source/geospaas/catalog.rst b/docs/source/geospaas.catalog.rst → docs/source/geospaas/catalog.rst
@@ -1,16 +1,16 @@
+========================
 geospaas.catalog package
 ========================
 
 Subpackages
------------
+===========
 
 .. toctree::
 
-    geospaas.catalog.management
-    geospaas.catalog.migrations
+    catalog/management
 
 Submodules
-----------
+==========
 
 geospaas.catalog.admin module
 -----------------------------
@@ -54,7 +54,7 @@ geospaas.catalog.views module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.catalog
     :members:

diff --git a/.../geospaas.catalog.management.commands.rst → .../geospaas/catalog/management.commands.rst b/.../geospaas.catalog.management.commands.rst → .../geospaas/catalog/management.commands.rst
@@ -1,8 +1,9 @@
+============================================
 geospaas.catalog.management.commands package
 ============================================
 
 Submodules
-----------
+==========
 
 geospaas.catalog.management.commands.count module
 -------------------------------------------------
@@ -14,7 +15,7 @@ geospaas.catalog.management.commands.count module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.catalog.management.commands
     :members:

diff --git a/docs/source/geospaas.catalog.management.rst → docs/source/geospaas/catalog/management.rst b/docs/source/geospaas.catalog.management.rst → docs/source/geospaas/catalog/management.rst
@@ -1,3 +1,4 @@
+===================================
 geospaas.catalog.management package
 ===================================
 
@@ -6,7 +7,7 @@ Subpackages
 
 .. toctree::
 
-    geospaas.catalog.management.commands
+    management.commands
 
 Module contents
 ---------------

diff --git a/docs/source/geospaas.export_DIF.rst → docs/source/geospaas/export_DIF.rst b/docs/source/geospaas.export_DIF.rst → docs/source/geospaas/export_DIF.rst
@@ -1,15 +1,9 @@
+============================
 geospaas.export\_DIF package
 ============================
 
-Subpackages
------------
-
-.. toctree::
-
-    geospaas.export_DIF.migrations
-
 Submodules
-----------
+==========
 
 geospaas.export\_DIF.admin module
 ---------------------------------
@@ -45,7 +39,7 @@ geospaas.export\_DIF.views module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.export_DIF
     :members:

diff --git a/docs/source/geospaas.nansat_ingestor.rst → docs/source/geospaas/nansat_ingestor.rst b/docs/source/geospaas.nansat_ingestor.rst → docs/source/geospaas/nansat_ingestor.rst
@@ -1,17 +1,16 @@
+=================================
 geospaas.nansat\_ingestor package
 =================================
 
 Subpackages
------------
+===========
 
 .. toctree::
 
-    geospaas.nansat_ingestor.management
-    geospaas.nansat_ingestor.migrations
-    geospaas.nansat_ingestor.tests
+    nansat_ingestor/management
 
 Submodules
-----------
+==========
 
 geospaas.nansat\_ingestor.admin module
 --------------------------------------
@@ -47,7 +46,7 @@ geospaas.nansat\_ingestor.views module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.nansat_ingestor
     :members:

diff --git a/...s.nansat_ingestor.management.commands.rst → ...s/nansat_ingestor/management.commands.rst b/...s.nansat_ingestor.management.commands.rst → ...s/nansat_ingestor/management.commands.rst
@@ -1,8 +1,9 @@
+=====================================================
 geospaas.nansat\_ingestor.management.commands package
 =====================================================
 
 Submodules
-----------
+==========
 
 geospaas.nansat\_ingestor.management.commands.ingest module
 -----------------------------------------------------------
@@ -22,7 +23,7 @@ geospaas.nansat\_ingestor.management.commands.ingest\_hyrax module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.nansat_ingestor.management.commands
     :members:

diff --git a/...e/geospaas.nansat_ingestor.management.rst → ...e/geospaas/nansat_ingestor/management.rst b/...e/geospaas.nansat_ingestor.management.rst → ...e/geospaas/nansat_ingestor/management.rst
@@ -1,3 +1,4 @@
+============================================
 geospaas.nansat\_ingestor.management package
 ============================================
 
@@ -6,7 +7,7 @@ Subpackages
 
 .. toctree::
 
-    geospaas.nansat_ingestor.management.commands
+    management.commands
 
 Module contents
 ---------------

diff --git a/docs/source/geospaas.utils.rst → docs/source/geospaas/utils.rst b/docs/source/geospaas.utils.rst → docs/source/geospaas/utils.rst
@@ -1,8 +1,9 @@
+======================
 geospaas.utils package
 ======================
 
 Submodules
-----------
+==========
 
 geospaas.utils.processing\_base\_command module
 -----------------------------------------------
@@ -22,7 +23,7 @@ geospaas.utils.utils module
 
 
 Module contents
----------------
+===============
 
 .. automodule:: geospaas.utils
     :members: