Updated Scraper Reference (markdown)

Thibaut Courouble committed 13 years ago

Commit 09c71d71 parent a8ffebc1 file · +1 −1Browse files

Unified · Split

Scraper-Reference.md+1−1

@@ -59,7 +59,7 @@ Configuration is done via class attributes and divided into three main categorie · 58 unmodified lines
59		59
60	* `base_url` [String] (required in `UrlScraper`)	60	* `base_url` [String] (required in `UrlScraper`)
61	The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).	61	The documents' location. Only URLs _inside_ the `base_url` will be scraped. "inside" more or less means "starting with" except that `/docs` is outside `/doc` (but `/doc/` is inside).
62	`FileScraper`'s default is `localhost`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)	62	Defaults to `localhost` in `FileScraper`. (Note: any iframe, image, or skipped link pointing to localhost will be removed by the `CleanLocalUrls` filter; the value should be overridden if the documents are available online.)
63	Unless `root_path` is set, the root/initial URL is equal to `base_url`.	63	Unless `root_path` is set, the root/initial URL is equal to `base_url`.
64		64
65	* `root_path` [String] (inherited)	65	* `root_path` [String] (inherited)