Modifying tests

ghislainv · May 28, 2024 · 53a420a · 53a420a
1 parent f7e3a61
commit 53a420a
Show file tree

Hide file tree

Showing 14 changed files with 42 additions and 30 deletions.
diff --git a/docsrc/articles.rst b/docsrc/articles.rst
@@ -5,5 +5,5 @@ Articles
    :maxdepth: 1
 
    notebooks/get_started/get_started.ipynb
-   notebooks/large_country/large_country
+   notebooks/large_countries/large_countries
 
diff --git a/docsrc/index.rst b/docsrc/index.rst
@@ -1,23 +1,14 @@
 .. include:: ../README.rst
-
-Table of contents
-=================
 
 .. toctree::
+   :hidden:
    :maxdepth: 2
 
    Home <self>
    notebooks/get_started/get_started
    articles
-   reference
+   python_api
    indices
    changelog
    license
 
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-
diff --git a/docsrc/indices.rst b/docsrc/indices.rst
@@ -2,5 +2,4 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
diff --git a/docsrc/notebooks/large_country/fcc.png → docsrc/notebooks/large_countries/fcc.png b/docsrc/notebooks/large_country/fcc.png → docsrc/notebooks/large_countries/fcc.png
diff --git a/...notebooks/large_country/large_country.org → ...books/large_countries/large_countries.org b/...notebooks/large_country/large_country.org → ...books/large_countries/large_countries.org
diff --git a/...notebooks/large_country/large_country.rst → ...books/large_countries/large_countries.rst b/...notebooks/large_country/large_country.rst → ...books/large_countries/large_countries.rst
diff --git a/...tebooks/large_country/large_country_1.org → ...oks/large_countries/large_countries_1.org b/...tebooks/large_country/large_country_1.org → ...oks/large_countries/large_countries_1.org
diff --git a/...tebooks/large_country/large_country_2.org → ...oks/large_countries/large_countries_2.org b/...tebooks/large_country/large_country_2.org → ...oks/large_countries/large_countries_2.org
diff --git a/docsrc/python_api.rst b/docsrc/python_api.rst
@@ -0,0 +1,7 @@
+Python API
+**********
+
+.. toctree::
+   :maxdepth: 2
+
+   python_api/functions.rst
diff --git a/docsrc/python_api/functions.rst b/docsrc/python_api/functions.rst
@@ -0,0 +1,3 @@
+.. autofunction:: geefcc.get_fcc
+.. autofunction:: geefcc.sum_raster_bands
+.. autofunction:: geefcc.make_dir
diff --git a/docsrc/reference.rst b/docsrc/reference.rst
diff --git a/geefcc/__init__.py b/geefcc/__init__.py
@@ -15,7 +15,7 @@
 from .ee_initialize import ee_initialize
 from .get_fcc import get_fcc
 from .sum_raster_bands import sum_raster_bands
-from . import misc
+from .misc import make_dir
 
 # GDAL exceptions
 gdal.UseExceptions()

diff --git a/test/test_get_fcc.py b/test/test_get_fcc.py
@@ -3,7 +3,7 @@
 # Import
 import os
 
-from geefcc import get_fcc, ee_initialize
+import geefcc as gf
 
 # "EARTHENGINE_TOKEN" for GitHub actions
 # https://github.com/gee-community/geemap/discussions/1341
@@ -13,15 +13,15 @@
 # with the name EARTHENGINE_TOKEN.
 
 # Initialize GEE
-ee_initialize(
+gf.ee_initialize(
     token_name="EARTHENGINE_TOKEN",
     project="forestatrisk",
     opt_url="https://earthengine-highvolume.googleapis.com")
 
 
 def test_get_fcc_extent_tmf():
     """Testing get_fcc()."""
-    get_fcc(
+    gf.get_fcc(
         # Extent for Reunion Island
         aoi=(55.21625137, -21.38986015, 55.83736038, -20.87180519),
         buff=0.08983152841195216,
@@ -35,7 +35,7 @@ def test_get_fcc_extent_tmf():
 
 def test_get_fcc_extent_gfc():
     """Testing get_fcc()."""
-    get_fcc(
+    gf.get_fcc(
         # Extent for Reunion Island
         aoi=(55.21625137, -21.38986015, 55.83736038, -20.87180519),
         buff=0.08983152841195216,

diff --git a/test/test_import.py b/test/test_import.py
@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+# ==============================================================================
+# author          :Ghislain Vieilledent
+# email           :[email protected], [email protected]
+# web             :https://ecology.ghislainv.fr
+# python_version  :>=2.7
+# license         :GPLv3
+# ==============================================================================
+
+
+# test_import
+def test_import():
+    """Test import."""
+    imp = True
+    try:
+        import geefcc
+    except ImportError:
+        imp = False
+    assert imp is True
+
+
+# End