Some config info

CodersOfTheNight · Sep 6, 2016 · 81d947d · 81d947d
1 parent 3016080
commit 81d947d
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 0 deletions.
diff --git a/docs/config.rst b/docs/config.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,3 +8,4 @@ Contents:
 
 	installing
 	usage
+        config
diff --git a/docs/installing.rst b/docs/installing.rst
@@ -5,6 +5,10 @@ Requirements
 ------------
 * Python 2.7, 3.4, 3.5, or PyPy
 
+Optional dependencies
+---------------------
+* `lxml` library inside system if you consider using it as a parser
+
 
 Installing
 ----------

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -0,0 +1,53 @@
+Configuration
+=============
+
+Config
+------
+
+============    ================       ======================================
+Value           Notes                   Description
+============    ================       ======================================
+name                                    A user-friendly name for configuration
+description                             Description about configuration
+site_root                               Site url which we will be scrapping
+start_page                              Where to start our scrapping
+cookies         (Optional, Array)       Add cookies to our requests
+headers         (Optional, Array)       Add headers to our requests
+proxies         (Optional, Array)       List of http proxies to be used for requests
+pages           (Array)                 Consists an array of `Page`
+parser          (Optional)              Select parser for web pages. Default: html.parser, or you can use lxml
+auth            (Optional)              `Auth` object
+============     ================       ======================================
+
+
+Auth
+----
+
+============    ================       ======================================
+Value           Notes                   Description
+============    ================       ======================================
+url                                     Login url
+method          (Optional)              Default: POST, you can add any other http method
+params          (Array)                 Key-Value pairs for request
+============    ================       ======================================
+
+Page
+----
+
+============    ================       ======================================
+Value           Notes                   Description
+============    ================       ======================================
+name                                    Name of page
+link_pattern                            Pattern which allows to detect which page parser to use
+mappings        (Array)                 Array of `Mapping`
+============    ================       ======================================
+
+Mapping
+-------
+
+============    ================       ======================================
+Value           Notes                   Description
+============    ================       ======================================
+name                                    Name of mapping
+path                                    Path to element
+============    ================       ======================================