Update doc links

sertit · Jan 15, 2025 · 8db3208 · 8db3208
1 parent 350662c
commit 8db3208
Show file tree

Hide file tree

Showing 11 changed files with 52 additions and 52 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -258,7 +258,7 @@
 
 - **ENH: Adding the support of Capella constellation** ([#74](https://github.com/sertit/eoreader/issues/74))
 - **ENH: Allow the user to load bands with a window (pixels and geo)** ([#25](https://github.com/sertit/eoreader/issues/25))
-  , [notebook](https://eoreader.readthedocs.io/en/latest/notebooks/windowed_reading.html))
+  , [notebook](https://eoreader.readthedocs.io/latest/notebooks/windowed_reading.html))
 
 ### Bug Fixes
 

diff --git a/README.md b/README.md
@@ -7,10 +7,10 @@
 [![stars](https://img.shields.io/github/stars/sertit/eoreader?style=social)](https://github.com/sertit/eoreader)
 [![Conda](https://img.shields.io/conda/dn/conda-forge/eoreader.svg)](https://anaconda.org/conda-forge/eoreader)
 
-# ![eoreader_logo](https://eoreader.readthedocs.io/en/latest/_static/favicon.png) EOReader
+# ![eoreader_logo](https://eoreader.readthedocs.io/latest/_static/favicon.png) EOReader
 
-**EOReader** is a remote-sensing opensource python library reading [optical](https://eoreader.readthedocs.io/en/latest/optical.html)
-and [SAR](https://eoreader.readthedocs.io/en/latest/sar.html) constellations, loading and stacking bands,
+**EOReader** is a remote-sensing opensource python library reading [optical](https://eoreader.readthedocs.io/latest/optical.html)
+and [SAR](https://eoreader.readthedocs.io/latest/sar.html) constellations, loading and stacking bands,
 clouds, DEM and spectral indices in a sensor-agnostic way.
 
 > [!IMPORTANT] 
@@ -20,21 +20,21 @@ clouds, DEM and spectral indices in a sensor-agnostic way.
 ## 🛰️ Managed constellations
 
 ### Optical
-[![Sentinel-2 SAFE and Theia Sentinel-3 OLCI and SLSTR Landsat 1 to 9 Harmonized Landsat-Sentinel PlanetScope, SkySat and RapidEye Pleiades and Pleiades-Neo SPOT-6/7 and 4/5 Vision-1 Maxar (WorldViews, GeoEye) SuperView-1 GEOSAT-2](https://zupimages.net/up/23/22/j3mz.png)](https://eoreader.readthedocs.io/en/latest/optical.html)
+[![Sentinel-2 SAFE and Theia Sentinel-3 OLCI and SLSTR Landsat 1 to 9 Harmonized Landsat-Sentinel PlanetScope, SkySat and RapidEye Pleiades and Pleiades-Neo SPOT-6/7 and 4/5 Vision-1 Maxar (WorldViews, GeoEye) SuperView-1 GEOSAT-2](https://zupimages.net/up/23/22/j3mz.png)](https://eoreader.readthedocs.io/latest/optical.html)
 
 ### SAR
-[![Sentinel-1 COSMO-Skymed 1st and 2nd Generation TerraSAR-X, TanDEM-X and PAZ SAR RADARSAT-2 and RADARSAT-Constellation ICEYE SAOCOM Capella](https://zupimages.net/up/23/22/7b6k.png)](https://eoreader.readthedocs.io/en/latest/sar.html)
+[![Sentinel-1 COSMO-Skymed 1st and 2nd Generation TerraSAR-X, TanDEM-X and PAZ SAR RADARSAT-2 and RADARSAT-Constellation ICEYE SAOCOM Capella](https://zupimages.net/up/23/22/7b6k.png)](https://eoreader.readthedocs.io/latest/sar.html)
 
 ## 🔮 Features
 
 EOReader implements **sensor-agnostic** features:
 
-- [`load`](https://eoreader.readthedocs.io/en/latest/api/eoreader.products.product.Product.html#eoreader.products.product.Product.load): Load many band types:
-    - satellite bands ([optical](https://eoreader.readthedocs.io/en/latest/optical.html#satellite-bands) or [SAR](https://eoreader.readthedocs.io/en/latest/sar.html#sar-bands))
-    - [index](https://eoreader.readthedocs.io/en/latest/optical.html#available-index)
-    - [cloud bands](https://eoreader.readthedocs.io/en/latest/optical.html#cloud-bands)
-    - [DEM bands](https://eoreader.readthedocs.io/en/latest/optical.html#dem-bands)
-- [`stack`](https://eoreader.readthedocs.io/en/latest/api/eoreader.products.product.Product.html#eoreader.products.product.Product.stack): Stack all these type of bands
+- [`load`](https://eoreader.readthedocs.io/latest/api/eoreader.products.product.Product.html#eoreader.products.product.Product.load): Load many band types:
+    - satellite bands ([optical](https://eoreader.readthedocs.io/latest/optical.html#satellite-bands) or [SAR](https://eoreader.readthedocs.io/latest/sar.html#sar-bands))
+    - [index](https://eoreader.readthedocs.io/latest/optical.html#available-index)
+    - [cloud bands](https://eoreader.readthedocs.io/latest/optical.html#cloud-bands)
+    - [DEM bands](https://eoreader.readthedocs.io/latest/optical.html#dem-bands)
+- [`stack`](https://eoreader.readthedocs.io/latest/api/eoreader.products.product.Product.html#eoreader.products.product.Product.stack): Stack all these type of bands
 
 EOReader works mainly with:
 - [`xarrays.DataArray`](http://xarray.pydata.org/en/stable/generated/xarray.DataArray.html#xarray.DataArray) and [`xarrays.Dataset`](http://xarray.pydata.org/en/stable/generated/xarray.Dataset.html#xarray.Dataset) for raster data
@@ -66,7 +66,7 @@ stack = s2_prod.stack([RED, GREEN, BLUE], stack_path="s2_rgb_stack.tif")
 ```
 
 EOReader aligns spectral bands from every handled sensor in order to make any call to a band generic:  
-[![Optical Band Mapping](https://zupimages.net/up/23/40/0zgb.png)](https://eoreader.readthedocs.io/en/latest/optical_band_mapping.html)
+[![Optical Band Mapping](https://zupimages.net/up/23/40/0zgb.png)](https://eoreader.readthedocs.io/latest/optical_band_mapping.html)
 
 ### SAR
 In the same way, you can import and stack radar band from any handled SAR constellation, with the same pattern.
@@ -101,35 +101,35 @@ stack = s1_prod.stack([VV_DSPK, VH_DSPK], stack_path="s1_stack.tif")
 
 ## 📖 Documentation
 
-The API documentation can be found [here](https://eoreader.readthedocs.io/en/latest/).
+The API documentation can be found [here](https://eoreader.readthedocs.io/latest/).
 
 ## 🔗 Examples
 
 Available notebooks provided as examples:
 
-- [Why EOReader?](https://eoreader.readthedocs.io/en/latest/notebooks/why_eoreader.html)
+- [Why EOReader?](https://eoreader.readthedocs.io/latest/notebooks/why_eoreader.html)
 
 ### Basics 
-- [Basic tutorial](https://eoreader.readthedocs.io/en/latest/notebooks/base.html)
-- [Optical data](https://eoreader.readthedocs.io/en/latest/notebooks/optical.html)
-- [SAR data](https://eoreader.readthedocs.io/en/latest/notebooks/SAR.html)
-- [VHR data](https://eoreader.readthedocs.io/en/latest/notebooks/VHR.html)
-- [Remove clouds](https://eoreader.readthedocs.io/en/latest/notebooks/remove_clouds.html)
+- [Basic tutorial](https://eoreader.readthedocs.io/latest/notebooks/base.html)
+- [Optical data](https://eoreader.readthedocs.io/latest/notebooks/optical.html)
+- [SAR data](https://eoreader.readthedocs.io/latest/notebooks/SAR.html)
+- [VHR data](https://eoreader.readthedocs.io/latest/notebooks/VHR.html)
+- [Remove clouds](https://eoreader.readthedocs.io/latest/notebooks/remove_clouds.html)
 
 
 ### Advanced 
-- [Sentinel-3 data](https://eoreader.readthedocs.io/en/latest/notebooks/sentinel-3.html)
-- [Water detection on multiple products](https://eoreader.readthedocs.io/en/latest/notebooks/water_detection.html)
-- [Windowed Reading](https://eoreader.readthedocs.io/en/latest/notebooks/windowed_reading.html)
-- [DEM](https://eoreader.readthedocs.io/en/latest/notebooks/dem.html)
-- [Custom stacks](https://eoreader.readthedocs.io/en/latest/notebooks/custom.html)
-- [Methods to clean optical bands](https://eoreader.readthedocs.io/en/latest/notebooks/optical_cleaning_methods.html)
-- [AWS storage](https://eoreader.readthedocs.io/en/latest/notebooks/aws.html)
-- [S3 Compatible Storage](https://eoreader.readthedocs.io/en/latest/notebooks/s3_compatible_storage.html)
+- [Sentinel-3 data](https://eoreader.readthedocs.io/latest/notebooks/sentinel-3.html)
+- [Water detection on multiple products](https://eoreader.readthedocs.io/latest/notebooks/water_detection.html)
+- [Windowed Reading](https://eoreader.readthedocs.io/latest/notebooks/windowed_reading.html)
+- [DEM](https://eoreader.readthedocs.io/latest/notebooks/dem.html)
+- [Custom stacks](https://eoreader.readthedocs.io/latest/notebooks/custom.html)
+- [Methods to clean optical bands](https://eoreader.readthedocs.io/latest/notebooks/optical_cleaning_methods.html)
+- [AWS storage](https://eoreader.readthedocs.io/latest/notebooks/aws.html)
+- [S3 Compatible Storage](https://eoreader.readthedocs.io/latest/notebooks/s3_compatible_storage.html)
 
 ### Experimental
-- [Dask](https://eoreader.readthedocs.io/en/latest/notebooks/dask.html)
-- [STAC](https://eoreader.readthedocs.io/en/latest/notebooks/stac.html)
+- [Dask](https://eoreader.readthedocs.io/latest/notebooks/dask.html)
+- [STAC](https://eoreader.readthedocs.io/latest/notebooks/stac.html)
 
 ## 🛠 Installation
 

diff --git a/docs/_static/optical_band_mapping.html b/docs/_static/optical_band_mapping.html
diff --git a/docs/_static/optical_band_mapping_inline.html b/docs/_static/optical_band_mapping_inline.html
diff --git a/docs/custom.md b/docs/custom.md
@@ -3,7 +3,7 @@
 Custom products can be created from any stack (and some data) provided by the user. These custom products will work
 exactly as usual products, but with the user's metadata.
 
-See [this notebook](https://eoreader.readthedocs.io/en/latest/notebooks/custom.html) for examples on how custom stacks
+See [this notebook](https://eoreader.readthedocs.io/latest/notebooks/custom.html) for examples on how custom stacks
 are working.
 
 ## Custom stack with minimum data

diff --git a/docs/faq.md b/docs/faq.md
@@ -13,7 +13,7 @@ EOReader always loads orthorectified bands, you cannot get raw bands !
     - Pay attention to give a sufficiently resolute DEM (does orthorectifying Pleiades data with a 30 m SRTM DEM make sense ?)
     - `gdalwarp` cannot access DEM through S3-compatible storage or https links. Be sure to link a DEM stored on disk.
     - This step is very time-consuming as the whole stack is reprojected for once. It may even never finish on your computer with very big images (sometimes VHR data can weight more than 15Go). It is best to give an already orthorectified stack on
-      the side, you can see an example in the [VHR Notebook](https://eoreader.readthedocs.io/en/latest/notebooks/VHR.html)
+      the side, you can see an example in the [VHR Notebook](https://eoreader.readthedocs.io/latest/notebooks/VHR.html)
 - For other constellations, non-orthorectified bands are not supported yet.
 
 ### I want to load bands with a custom CRS, what do I need to do ?

diff --git a/docs/main_features.md b/docs/main_features.md
@@ -1,14 +1,14 @@
 # Main features
 
-These features can be seen in the [basic tutorial](https://eoreader.readthedocs.io/en/latest/notebooks/base.html).
+These features can be seen in the [basic tutorial](https://eoreader.readthedocs.io/latest/notebooks/base.html).
 
 ## Open
 
 The reader singleton is your unique entry.
 It will create for you the product object corresponding to your satellite data.
 
 You can load products from the cloud, see 
-[this tutorial](https://eoreader.readthedocs.io/en/latest/notebooks/s3_compatible_storage.html).
+[this tutorial](https://eoreader.readthedocs.io/latest/notebooks/s3_compatible_storage.html).
 S3 and S3 Compatible Storage are working and maybe Google and Azure if `rasterio` supports it, 
 but they have not been tested.
 
@@ -137,12 +137,12 @@ but this can be changed according to the user's needs (see below).
 ```
 
 Some additional arguments can be passed to this function, please see {meth}`~eoreader.keywords` for the list.
-- Methods to clean optical bands are best described [here](https://eoreader.readthedocs.io/en/latest/notebooks/optical_cleaning_methods.html),
-- Sentinel-3 additional keywords use is highlighted in the [corresponding notebook](https://eoreader.readthedocs.io/en/latest/notebooks/sentinel-3.html).
-- Windows can be passed to the `load` and `stack` functions ([notebook](https://eoreader.readthedocs.io/en/latest/notebooks/windowed_reading.html)).
+- Methods to clean optical bands are best described [here](https://eoreader.readthedocs.io/latest/notebooks/optical_cleaning_methods.html),
+- Sentinel-3 additional keywords use is highlighted in the [corresponding notebook](https://eoreader.readthedocs.io/latest/notebooks/sentinel-3.html).
+- Windows can be passed to the `load` and `stack` functions ([notebook](https://eoreader.readthedocs.io/latest/notebooks/windowed_reading.html)).
 
 💡 The bands will be opened with a chunk of `[1, TILE_SIZE, TILE_SIZE]` with `TILE_SIZE` coming from the 
-[`EOREADER_TILE_SIZE` environment variable](https://eoreader.readthedocs.io/en/latest/api/eoreader.env_vars.TILE_SIZE.html#eoreader.env_vars.TILE_SIZE). 
+[`EOREADER_TILE_SIZE` environment variable](https://eoreader.readthedocs.io/latest/api/eoreader.env_vars.TILE_SIZE.html#eoreader.env_vars.TILE_SIZE). 
 The `TILE_SIZE` default value is 2048.
 
 
@@ -169,9 +169,9 @@ For example, for Sentinel-3 OLCI you can use `7`, `Oa07` or `YELLOW`. For Landsa
 
 Some additional arguments can be passed to this function, please see {meth}`~eoreader.keywords` for the list.
 - Methods to clean optical bands are best
-  described [here](https://eoreader.readthedocs.io/en/latest/notebooks/optical_cleaning_methods.html),
-- Sentinel-3 additional keywords use is highlighted in the [corresponding notebook](https://eoreader.readthedocs.io/en/latest/notebooks/sentinel-3.html).
-- Windows can be passed to the `load` and `stack` functions ([notebook](https://eoreader.readthedocs.io/en/latest/notebooks/windowed_reading.html)).
+  described [here](https://eoreader.readthedocs.io/latest/notebooks/optical_cleaning_methods.html),
+- Sentinel-3 additional keywords use is highlighted in the [corresponding notebook](https://eoreader.readthedocs.io/latest/notebooks/sentinel-3.html).
+- Windows can be passed to the `load` and `stack` functions ([notebook](https://eoreader.readthedocs.io/latest/notebooks/windowed_reading.html)).
 
 ## Read Metadata
 EOReader gives you the access to the metadata of your product as a `lxml.etree._Element` followed by the namespace you may need to read them 
@@ -221,7 +221,7 @@ This is what you will have when calling this function:
 ## Plot
 If a quicklook exists, the user can plot the product.
 Always existing for VHR and SAR data, more rarely for other optical constellations.
-See [Optical](https://eoreader.readthedocs.io/en/latest/notebooks/optical.html) and [SAR](https://eoreader.readthedocs.io/en/latest/notebooks/SAR.html) tutorials for examples.
+See [Optical](https://eoreader.readthedocs.io/latest/notebooks/optical.html) and [SAR](https://eoreader.readthedocs.io/latest/notebooks/SAR.html) tutorials for examples.
 
 ```python
 # Plot product
@@ -297,7 +297,7 @@ prod.get_orbit_direction()
 
 **EOReader** can help you create [SpatioTemporal Asset Catalog (STAC)](https://stacspec.org/) items from every supported products, included custom ones.
 Those items are ready to be added in any STAC catalogue or collection. 
-See [STAC Notebook](https://eoreader.readthedocs.io/en/latest/notebooks/stac.html) to learn more about this feature.
+See [STAC Notebook](https://eoreader.readthedocs.io/latest/notebooks/stac.html) to learn more about this feature.
 
 ```python
 # Get STAC object

diff --git a/docs/optical.md b/docs/optical.md
@@ -1,6 +1,6 @@
 # Optical data
 
-You will find an optical tutorial [here](https://eoreader.readthedocs.io/en/latest/notebooks/optical.html).
+You will find an optical tutorial [here](https://eoreader.readthedocs.io/latest/notebooks/optical.html).
 
 ## Implemented optical constellation
 
@@ -96,12 +96,12 @@ Optical bands are always loaded in reflectance, except for brilliance temperatur
 
 However, the user can ask for bands "as is" by using the {meth}`~eoreader.keyword.TO_REFLECTANCE` keyword with the load and stack functions.
 It will give the bands in the provider format (either DN, radiance or reflactance in uint16...).
-See [the optical notebook](https://eoreader.readthedocs.io/en/latest/notebooks/optical.html#radiometric-processing) to see how to implement it.
+See [the optical notebook](https://eoreader.readthedocs.io/latest/notebooks/optical.html#radiometric-processing) to see how to implement it.
 
 These bands will be cleaned according to the user's needs. 
 By default, only the pixels outside the detectors footprints are set to nodata.
 Methods to clean optical bands are best described in the
-[notebook](https://eoreader.readthedocs.io/en/latest/notebooks/optical_cleaning_methods.html) about the optical cleaning methods.
+[notebook](https://eoreader.readthedocs.io/latest/notebooks/optical_cleaning_methods.html) about the optical cleaning methods.
 ```
 
 #### Band names

diff --git a/docs/sar.md b/docs/sar.md
@@ -1,6 +1,6 @@
 # SAR data
 
-You will find a SAR tutorial [here](https://eoreader.readthedocs.io/en/latest/notebooks/SAR.html).
+You will find a SAR tutorial [here](https://eoreader.readthedocs.io/latest/notebooks/SAR.html).
 
 ## Implemented SAR constellations
 
@@ -305,7 +305,7 @@ If `External DEM` is set, you must specify the DEM you want by positioning the `
 
 ## Known SNAP bugs
 
-See the [FAQ](https://eoreader.readthedocs.io/en/latest/faq.html#snap-known-bugs) for known SNAP bugs.
+See the [FAQ](https://eoreader.readthedocs.io/latest/faq.html#snap-known-bugs) for known SNAP bugs.
 
 ### What to know if you are changing a graph
 

diff --git a/eoreader/reader.py b/eoreader/reader.py
@@ -612,7 +612,7 @@ def open(
             )
             LOGGER.debug(
                 "Please look at what folder you should give to EOReader by accessing the documentation: "
-                "https://eoreader.readthedocs.io/en/latest/main_features.html#recognized-paths"
+                "https://eoreader.readthedocs.io/latest/main_features.html#recognized-paths"
             )
 
         return prod

diff --git a/pyproject.toml b/pyproject.toml
@@ -66,7 +66,7 @@ version = {attr = "eoreader.__version__"}
 
 [project.urls]
 Bug_Tracker = "https://github.com/sertit/eoreader/issues"
-Documentation =  "https://eoreader.readthedocs.io/en/latest/"
+Documentation =  "https://eoreader.readthedocs.io/latest/"
 Source_Code = "https://github.com/sertit/eoreader"
 
 [tool.ruff]