Commits

luoboiqingcai  committed 3a979a8

refine api documents.

  • Participants
  • Parent commits 39c537c

Comments (0)

Files changed (4)

File doc/downloadduxiu_api.rst

-=================
-downloadduxiu api
-=================
-
-.. automodule:: downloadduxiu
-   :members:

File doc/downloadlib_api.rst

+=================
+downloadduxiu api
+=================
+
+.. automodule:: downloadduxiu
+   :members:

File doc/gendocument_api.rst

 
 .. note::
 
-    This script require reportlab installed.
+    This script runs on python 2.7 platform and require reportlab installed.
 
 .. automodule:: gendocument
    :members:

File doc/index.rst

 
 Although some preparations are need:
 
- #. python 2.7 installed
+ #. python 3 installed
+ #. requests package installed
  #. reportlab installed if you want to use gendocument.py script
 
 
 modules included in the package
 ================================
 
-downloadduxiu
+downloadlib
 --------------
 
 This is the main module of the package.
 ::
 
     # prex direction must be created in order to execute this command.
-    ./downloadduxiu.py --prex=prex  --logfile=logfile 'yourlink'
+    ./downloadlib.py --prex=prex  --logfile=logfile --method=1 "yourlink"
 
     # utilize multiprocess function
-    ./downloadduxiu.py --prex=prex --logfile=logfile --procnum=2 'yourlink'
+    ./downloadlib.py --prex=prex --logfile=logfile --method=1 --procnum=2 "yourlink"
 
 
 prefaces
 
 .. note::
 
-    This script require reportlab installed.
+    This script runs on python 2.7 because it requires reportlab to generate pdf files.
 
 ::
 
 gui
 ----
 
+.. WARNING:: This script is deprecated. Run downloadlib.py directly.
+
 This script provides gui for downloadduxiu script.
 
 ::
 .. toctree::
    :maxdepth: 2
 
-   downloadduxiu_api
+   downloadlib_api
    prefaces_api
    gendocument_api
    gui_api