| Name | Type | Description |
|---|---|---|
path* | Union[str, Path] | The location of pulled readthedocs folder. |
encoding | Optional[str] | Default: NoneThe encoding with which to open the documents. |
errors | Optional[str] | Default: None |
custom_html_tag | Optional[Tuple[str, dict]] | Default: None |
patterns | Sequence[str] | Default: ('*.htm', '*.html') |
exclude_links_ratio | float | Default: 1.0 |
kwargs | Optional[Any] | Default: {} |
Load ReadTheDocs documentation directory.
Specify how encoding and decoding errors are to be handled—this cannot be used in binary mode.
Optional custom html tag to retrieve the content from files.
The file patterns to load, passed to glob.rglob.
The ratio of links:content to exclude pages from. This is to reduce the frequency at which index pages make their way into retrieved results. Recommended: 0.5
named arguments passed to bs4.BeautifulSoup.
