Commits

luoboiqingcai committed 0cb37d8

refine doc

Comments (0)

Files changed (8)

 test/*.html
 *.pdf
 doc/_build/*
+Include/*
+Lib/*
+Scripts/*
+build/*
 *downloadduxiu.py*::
 
     # prex direction must be created in order to execute this command.
-    ./downloadduxiu.py --tofile=tofile --prex=prex 'yourlink'
+
+    # on linux
+    ./downloadduxiu.py --tofile=tofile --prex=prex --procnum=n 'yourlink'
+    # on windows
+    downloadduxiu.py --tofile=tofile --prex=prex --procnum=n 'yourlink'
 
 *prefaces.py*::
 
     # this script must be run first to prepare the prefaces before any images copyed to current direction.
+
+    # on linux
     ./prefaces.py *.jpg *.png
+    # on windows
+    prefaces.py *.jpg *.png
 
 *gendocument.py*::
 
     # copy preface images prepared in last step to where content page images sit and use command below to generate the whole document.
+
+    # on linux
     ./gendocument.py --tofile=somename.pdf *.png *.jpg
+    # on windows
+    gendocument.py --tofile=somename.pdf *.png *.jpg
+
+*gui.py*:: 
+
+    # on linux
+    ./gui.py
+    # on windows
+    gui.py
 
 Usage on Windows
 =================
     import os
 
     def main(s):
-        os.system('downloadduxiu.py --prex=xiazai --logfile=logfile "%s"'%s)
+        os.system('downloadduxiu.py --prex=xiazai --logfile=logfile --procnum=1 "%s"'%s)
 
     if __name__ == '__main__':
         # replace your link with your actual link sat in your email.

doc/files.rst

-.. _my-ref:
-
-================================
-modules included in the package
-================================
-
-downloadduxiu
-==============
-
-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'
-
-    # utilize multiprocess function
-    ./downloadduxiu.py --prex=prex --logfile=logfile --procnum=2 'yourlink'
-
-
-prefaces
-=========
-
-This script is used to preprocess the preface of the ducument in order to make it ordered to be inserted in the pdf document to be generated.
-
-::
-
-    # this script must be run first to prepare the prefaces before any images copyed to current direction.
-    ./prefaces.py *.jpg *.png
-
-
-gendocument
-============
-
-This script is used to generate pdf document from images download by downloadduxiu ang prefaces download manually.
-
-.. note::
-
-    This script require reportlab installed.
-
-::
-
-    # copy preface images prepared in last step to where content page images sit and use command below to generate the whole document.
-    ./gendocument.py --tofile=somename.pdf *.png *.jpg
-
-
-gui
-====
-
-This script provides gui for downloadduxiu script.
-
-::
-
-    # you have to create a direcotry named "xiazai" where all the python source sit.
-    ./gui.py
-
-Enter the url you get from your email and click ok to start download.
-
-When it is finished, "finished" will show in the input area. Clear the input area and fill in your next url to begin a new download.
-
-This script is the easiest way to utilize this package.

doc/gendocument.rst

-============
-gendocument
-============
-
-This script is used to generate pdf document from images download by downloadduxiu ang prefaces download manually.
-
-::
-
-    # copy preface images prepared in last step to where content page images sit and use command below to generate the whole document.
-    ./gendocument.py --tofile=somename.pdf *.png *.jpg
 Welcome to downloadduxiu's documentation!
 =========================================
 
-Contents:
 
-.. toctree::
-   :maxdepth: 2
+Introduce to downloadduxiu
+---------------------------
+.. module:: downloadduxiu
+   :platform: Unix, Windows
+   :synopsis: to download papers from duxiu.
+.. moduleauthor:: luoboiqingcai <sf.cumt@gmail.com>
 
-   introduce
-   files
-   Install this package<install>
+This **downloadduxiu** package is used to download books either from duxiu or from chaoxing if the book is accessable in your browsers.
+
+Refer to modules inclued in the package( :ref:`modules included in the package <my-ref>`)
+
+
+Install this package
+---------------------
+
+This package is quite simple and is not necessary to be installed.
+
+Although some preparations are need:
+
+ #. python 2.7 installed
+ #. reportlab installed if you want to use gendocument.py script
+
+
+modules included in the package
+================================
+
+downloadduxiu
+--------------
+
+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'
+
+    # utilize multiprocess function
+    ./downloadduxiu.py --prex=prex --logfile=logfile --procnum=2 'yourlink'
+
+
+prefaces
+---------
+
+This script is used to preprocess the preface of the ducument in order to make it ordered to be inserted in the pdf document to be generated.
+
+::
+
+    # this script must be run first to prepare the prefaces before any images copyed to current direction.
+    ./prefaces.py *.jpg *.png
+
+
+gendocument
+------------
+
+This script is used to generate pdf document from images download by downloadduxiu ang prefaces download manually.
+
+.. note::
+
+    This script require reportlab installed.
+
+::
+
+    # copy preface images prepared in last step to where content page images sit and use command below to generate the whole document.
+    ./gendocument.py --tofile=somename.pdf *.png *.jpg
+
+
+gui
+----
+
+This script provides gui for downloadduxiu script.
+
+::
+
+    # you have to create a direcotry named "xiazai" where all the python source sit.
+    ./gui.py
+
+Enter the url you get from your email and click ok to start download.
+
+When it is finished, "finished" will show in the input area. Clear the input area and fill in your next url to begin a new download.
+
+This script is the easiest way to utilize this package.
 
 API Documentation
 ==================

doc/install.rst

-=====================
-Install this package
-=====================
-
-This package is quite simple and is not necessary to be installed.
-
-Although some preparations are need:
-
- #. python 2.7 installed
- #. reportlab installed if you want to use gendocument.py script

doc/introduce.rst

-===========================
-Introduce to downloadduxiu
-===========================
-
-.. module:: downloadduxiu
-   :platform: Unix, Windows
-   :synopsis: to download papers from duxiu.
-.. moduleauthor:: luoboiqingcai <sf.cumt@gmail.com>
-
-This **downloadduxiu** package is used to download books either from duxiu or from chaoxing if the book is accessable in your browsers.
-
-Refer to modules inclued in the package( :ref:`modules included in the package <my-ref>`)

doc/prefaces.rst

-=========
-prefaces
-=========
-
-This script is used to preprocess the preface of the ducument in order to make it ordered to be inserted in the pdf document to be generated.
-
-::
-
-    # this script must be run first to prepare the prefaces before any images copyed to current direction.
-    ./prefaces.py *.jpg *.png
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.