This commit finalizes the documentation for configuration.

sentinel-hub · Mar 1, 2021 · 0fbe4af · 0fbe4af
1 parent e460680
commit 0fbe4af
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 10 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -54,7 +54,8 @@
     'nbsphinx',
     'sphinx.ext.mathjax',
     'sphinx.ext.viewcode',
-    'sphinx.ext.githubpages'
+    'sphinx.ext.githubpages',
+    'sphinx_reredirects'
 ]
 
 # Both the class’ and the __init__ method’s docstring are concatenated and inserted.
@@ -223,3 +224,8 @@
     shutil.copytree('../../examples', './examples')
 except FileExistsError:
     pass
+
+# redirects
+redirects = {
+    "examples/processing_api_request": "examples/process_request.html",
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,10 +7,10 @@ Documentation of Sentinel Hub Python package
 ********************************************
 
 Documentation for Python utility packages developed by the 
-EO research team at `Sinergise <http://www.sinergise.com/>`_.
+EO research team at `Sinergise <https://www.sinergise.com/>`_.
 
 This code allows one to reproduce some of the functionalities of the 
-EO service `Sentinel Hub <http://www.sentinel-hub.com/>`_.
+EO service `Sentinel Hub <https://www.sentinel-hub.com/>`_.
 The code is available on `GitHub <https://github.com/sentinel-hub/sentinelhub-py/>`_.
 
 .. toctree::

diff --git a/examples/aws_request.ipynb b/examples/aws_request.ipynb
@@ -15,7 +15,7 @@
     "\n",
     "The ```sentinelhub``` package supports obtaining data by specifying products or by specifying tiles. It can download data either to the same file structure as it is at AWS or it can download data into original ```.SAFE``` file structure [introduced by ESA](https://sentinel.esa.int/web/sentinel/user-guides/sentinel-2-msi/data-formats).\n",
     "\n",
-    "Before testing any of the examples below please check [Configuration paragraph](http://sentinelhub-py.readthedocs.io/en/latest/configure.html#amazon-s3-capabilities) for details about configuring AWS credentials and information about charges."
+    "Before testing any of the examples below please check [Configuration paragraph](https://sentinelhub-py.readthedocs.io/en/latest/configure.html#amazon-s3-capabilities) for details about configuring AWS credentials and information about charges."
    ]
   },
   {
@@ -57,7 +57,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For this functionality Sentinel Hub instance ID has to be configured according to [Configuration paragraph](http://sentinelhub-py.readthedocs.io/en/latest/configure.html#sentinel-hub-capabilities)."
+    "For this functionality Sentinel Hub instance ID has to be configured according to [Configuration paragraph](https://sentinelhub-py.readthedocs.io/en/latest/configure.html#sentinel-hub-capabilities)."
    ]
   },
   {
@@ -161,7 +161,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "- Automatic search with functions from [sentinelhub.opensearch](http://sentinelhub-py.readthedocs.io/en/latest/opensearch.html) module (no authentication required):"
+    "- Automatic search with functions from [sentinelhub.opensearch](https://sentinelhub-py.readthedocs.io/en/latest/opensearch.html) module (no authentication required):"
    ]
   },
   {

diff --git a/examples/byoc_request.ipynb b/examples/byoc_request.ipynb
@@ -64,7 +64,7 @@
    "source": [
     "## Prerequisites\n",
     "\n",
-    "BYOC API requires Sentinel Hub account. Please see [configuration instructions](http://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
+    "BYOC API requires Sentinel Hub account. Please see [configuration instructions](https://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
    ]
   },
   {

diff --git a/examples/data_search.ipynb b/examples/data_search.ipynb
@@ -49,7 +49,7 @@
     "\n",
     "### Prerequisites\n",
     "\n",
-    "BYOC API requires Sentinel Hub account. Please see [configuration instructions](http://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
+    "BYOC API requires Sentinel Hub account. Please see [configuration instructions](https://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
    ]
   },
   {

diff --git a/examples/ogc_request.ipynb b/examples/ogc_request.ipynb
@@ -16,7 +16,7 @@
     "**Disclaimer:**\n",
     "    \n",
     "Sentinel Hub service has a dedicated [Process API](https://docs.sentinel-hub.com/api/latest/#/API/) that extends the limiting capabilities of the standard OGC endpoints. \n",
-    "We advise you to move to Process API and enjoy the full power of Sentinel Hub services. See the [notebook](./processing_api_request.ipynb) with Processing API examples.\n",
+    "We advise you to move to Process API and enjoy the full power of Sentinel Hub services. See the [notebook](./process_request.ipynb) with Process API examples.\n",
     "</div>"
    ]
   },

diff --git a/examples/process_request.ipynb b/examples/process_request.ipynb
@@ -17,7 +17,7 @@
     "\n",
     "### Credentials\n",
     "\n",
-    "Process API requires Sentinel Hub account. Please see [configuration instructions](http://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
+    "Process API requires Sentinel Hub account. Please see [configuration instructions](https://sentinelhub-py.readthedocs.io/en/latest/configure.html) how to set up your configuration."
    ]
   },
   {

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -3,3 +3,4 @@ sphinx_rtd_theme
 nbsphinx
 matplotlib
 ipython
+sphinx-reredirects