Merge pull request #25 from hi-paris/documentation_page

Enhance documentation
hi-paris · Apr 9, 2024 · 1217d8c · 1217d8c
2 parents d0cb54f + d014de8
commit 1217d8c
Show file tree

Hide file tree

Showing 63 changed files with 29 additions and 10,067 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -17,15 +17,24 @@ jobs:
       - name: Set up Python 3.10
         uses: actions/setup-python@v2
         with:
-           python-version: "3.10"
+          python-version: "3.10"
+
+
+      - name: Set up gdal 
+        run : sudo apt-get install libgdal-dev
+
       # Runs a single command using the runners shell
       - name: Run a one-line script
         run: echo Hello, world!
 
       - name: Install dependencies
         run: | 
           python -m pip install --upgrade pip
-          pip install ghp-import sphinx sphinx_rtd_theme
+          pip install ghp-import sphinx sphinx_rtd_theme -e .
+
+      - name: Install gdal dependencies 
+        run : pip install --global-option=build_ext --global-option="-I/usr/include/gdal" GDAL==`gdal-config --version`
+
       - name: Build HTML
         run: | 
           cd docs/

diff --git a/deepdespeckling/test_deepdespeckling.py b/deepdespeckling/test_deepdespeckling.py
@@ -5,5 +5,5 @@
 coordinates_dictionnary = {'x_start': 0,
                            'y_start': 0, 'x_end': 400, 'y_end': 400}
 
-despeckle(image_path, destination_directory,
-          model_name="sar2sar")
+"""despeckle(image_path, destination_directory,
+          model_name="sar2sar")"""
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
diff --git a/docs/_build/html/_modules/deepdespeckling/denoiser.html b/docs/_build/html/_modules/deepdespeckling/denoiser.html