Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: move queryables doc to a new notebook #1447

Merged
Merged
4 changes: 2 additions & 2 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,10 @@ Core features and fixes
* Configurable download timeout (:pull:`1124`)
* `Search by id <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/4_search.html#id-and-provider>`_ now
uses :meth:`~eodag.api.core.EODataAccessGateway.search_all` and
`crunch <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/6_crunch.html#Filter-by-property>`_
`crunch <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/7_crunch.html#Filter-by-property>`_
(:pull:`1099`).
* Free text search available for all fields when `guessing a produc type
<https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/6_crunch.html#Filter-by-property>`_ (:pull:`1070`),
<https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/7_crunch.html#Filter-by-property>`_ (:pull:`1070`),
mission dates filtering support (:pull:`1222`)
* Configurable requests ``ssl_verify`` (:pull:`1045`)
* Download record hash independent from provider (:pull:`1023`)
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ The notebooks listed below are **always executed** by `nbsphinx`:

* `<notebooks/api_user_guide/2_providers_products_available.ipynb>`_
* `<notebooks/api_user_guide/3_configuration.ipynb>`_
* `<notebooks/api_user_guide/6_crunch.ipynb>`_
* `<notebooks/api_user_guide/7_crunch.ipynb>`_

For the other notebooks, their **cell output as long as their widget state** need so be saved.
If not, the outputs and the widgets (e.g. progress bar) won't be displayed in the online documentation.
Expand Down
5 changes: 5 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -91,3 +91,8 @@ dl.attribute dt {
dl.attribute dd {
grid-column-start: 2;
}

.nboutput table {
margin-left: unset;
margin-right: unset;
}
18 changes: 17 additions & 1 deletion docs/_static/product_types_information.csv

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions docs/api_user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ or run locally after being downloaded (see how to :ref:`install_notebooks`).

.. warning::

The `Download <notebooks/api_user_guide/7_download.ipynb>`_ notebook downloads a few
The `Download <notebooks/api_user_guide/8_download.ipynb>`_ notebook downloads a few
EO products. These products are usually in the order of 700-900 Mo, make sure you have a
decent internet connection if you plan to run the notebooks.

Expand All @@ -25,7 +25,8 @@ or run locally after being downloaded (see how to :ref:`install_notebooks`).
notebooks/api_user_guide/2_providers_products_available.ipynb
notebooks/api_user_guide/3_configuration.ipynb
notebooks/api_user_guide/4_search.ipynb
notebooks/api_user_guide/5_serialize_deserialize.ipynb
notebooks/api_user_guide/6_crunch.ipynb
notebooks/api_user_guide/7_download.ipynb
notebooks/api_user_guide/8_post_process.ipynb
notebooks/api_user_guide/5_queryables.ipynb
notebooks/api_user_guide/6_serialize_deserialize.ipynb
notebooks/api_user_guide/7_crunch.ipynb
notebooks/api_user_guide/8_download.ipynb
notebooks/api_user_guide/9_post_process.ipynb
2 changes: 1 addition & 1 deletion docs/getting_started_guide/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ will be stored and used if further authentication tries fail:
dag._plugins_manager.get_auth_plugin("creodias").authenticate()

Please note that authentication mechanism is already included in
`download methods <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/7_download.html>`_ , so you could
`download methods <https://eodag.readthedocs.io/en/stable/notebooks/api_user_guide/8_download.html>`_ , so you could
also directly execute a download to retrieve the token while the OTP is still valid.

Use OTP through CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started_guide/product_storage_status.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ its different values mapped to these 3 unique status:
* `OFFLINE`: the product is not available for download, but can eventually be ordered.

``eodag`` is able to order `OFFLINE` products and retry downloading them for a while. This
is described in more details in the `Python API user guide <../notebooks/api_user_guide/7_download.ipynb>`_.
is described in more details in the `Python API user guide <../notebooks/api_user_guide/8_download.ipynb>`_.
Loading
Loading