Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Fanchengyan committed Apr 14, 2024
1 parent 67de033 commit 99f46a5
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 28 deletions.
14 changes: 6 additions & 8 deletions docs/source/api/downloader.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,20 @@ downloader

This module provides a multiple download functions for downloading files from given urls.

..currentmodule:: data_downloader.downloader

.. csv-table::
:file: tables/downloader.csv
:header-rows: 1

Functions
---------

.. _download_data:
.. automethod:: data_downloader.downloader.download_data
.. automethod:: download_data

.. _download_datas:
.. automethod:: data_downloader.downloader.download_datas
.. automethod:: download_datas

.. _async_download_datas:
.. automethod:: data_downloader.downloader.async_download_datas
.. automethod:: async_download_datas

.. _mp_download_datas:
.. automethod:: data_downloader.downloader.mp_download_datas
.. automethod:: mp_download_datas

10 changes: 5 additions & 5 deletions docs/source/api/tables/downloader.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Functions, Description
:func:`.download_data`, download a single file from a given url
:func:`.download_datas`, sequentially download multiple files from given urls
:func:`.async_download_datas`, asynchronously download multiple files from given urls
:func:`.mp_download_datas`, download multiple files from given urls using multiprocessing
Functions ,Description
:func:`.download_data` ,download a single file from a given url
:func:`.download_datas` ,sequentially download multiple files from given urls
:func:`.async_download_datas` ,asynchronously download multiple files from given urls
:func:`.mp_download_datas` ,download multiple files from given urls using multiprocessing
8 changes: 4 additions & 4 deletions docs/source/api/tables/hyp3.csv
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
classes, Description
:class:`.Jobs`, A class to manage HyP3 jobs. This class is designed to be used as the jobs attribute of the :class:`.HyP3Service` class
:class:`.JOB_TYPE`, A class containing the job types that can be submitted to HyP3
:class:`.STATUS_CODE`, A class containing the status of jobs that have be submitted to HyP3
classes ,Description
:class:`.Jobs` ,A class to manage HyP3 jobs. This class is designed to be used as the jobs attribute of the :class:`.HyP3Service` class
:class:`.JOB_TYPE` ,A class containing the job types that can be submitted to HyP3
:class:`.STATUS_CODE` ,A class containing the status of jobs that have be submitted to HyP3
10 changes: 5 additions & 5 deletions docs/source/api/tables/parse_urls.csv
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Functions, Description
:func:`.from_urls_file`, parse urls from a file which only contains urls
:func:`.from_html`, parse urls from html website
:func:`.from_sentinel_meta4`, parse a urls from a given JSON file
:func:`.from_EarthExplorer_order`, parse urls from orders in earthexplorer
Functions ,Description
:func:`.from_urls_file` ,parse urls from a file which only contains urls
:func:`.from_html` ,parse urls from html website
:func:`.from_sentinel_meta4` ,parse a urls from a given JSON file
:func:`.from_EarthExplorer_order` ,parse urls from orders in earthexplorer
12 changes: 6 additions & 6 deletions docs/source/api/tables/services.csv
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Online services, classes, Description
HyP3,:class:`.HyP3Service`,a class to manage HyP3 user information and jobs
,:class:`.InSARMission`,a class to manage HyP3 ``INSAR_GAMMA`` jobs
,:class:`.InSARBurstMission`,a class to manage HyP3 ``INSAR_ISCE_BURST`` jobs
LiCSAR,:class:`.LiCSARService`,a class to retrieve LiCSAR data
Sentinel-1 Orbit,:class:`.SentinelOrbit`,a class to retrieve Sentinel-1 orbit data links.
Online services ,classes ,Description
HyP3 ,:class:`.HyP3Service` ,a class to manage HyP3 user information and jobs
,:class:`.InSARMission` ,a class to manage HyP3 ``INSAR_GAMMA`` jobs
,:class:`.InSARBurstMission` ,a class to manage HyP3 ``INSAR_ISCE_BURST`` jobs
LiCSAR ,:class:`.LiCSARService` ,a class to retrieve LiCSAR data
Sentinel-1 Orbit ,:class:`.SentinelOrbit` ,a class to retrieve Sentinel-1 orbit data links.

0 comments on commit 99f46a5

Please sign in to comment.