Skip to main content
`Ctrl`+`K`

#

# Source code for langchain.document_loaders.readthedocs

    """Loader that loads ReadTheDocs documentation directory dump."""
    from pathlib import Path
    from typing import Any, List, Optional

    from langchain.docstore.document import Document
    from langchain.document_loaders.base import BaseLoader

    class ReadTheDocsLoader(BaseLoader):
        """Loader that loads ReadTheDocs documentation directory dump."""

        def __init__(
            self,
            path: str,
            encoding: Optional[str] = None,
            errors: Optional[str] = None,
            **kwargs: Optional[Any]
        ):
            """Initialize path."""
            try:
                from bs4 import BeautifulSoup

            except ImportError:
                raise ValueError(
                    "Could not import python packages. "
                    "Please install it with `pip install beautifulsoup4`. "
                )

            try:
                _ = BeautifulSoup(
                    "<html><body>Parser builder library test.</body></html>", **kwargs
                )
            except Exception as e:
                raise ValueError("Parsing kwargs do not appear valid") from e

            self.file_path = path
            self.encoding = encoding
            self.errors = errors
            self.bs_kwargs = kwargs

        def load(self) -> List[Document]:
            """Load documents."""
            from bs4 import BeautifulSoup

            def _clean_data(data: str) -> str:
                soup = BeautifulSoup(data, **self.bs_kwargs)
                text = soup.find_all("main", {"id": "main-content"})

                if len(text) == 0:
                    text = soup.find_all("div", {"role": "main"})

                if len(text) != 0:
                    text = text[0].get_text()
                else:
                    text = ""
                return "\n".join([t for t in text.split("\n") if t])

            docs = []
            for p in Path(self.file_path).rglob("*"):
                if p.is_dir():
                    continue
                with open(p, encoding=self.encoding, errors=self.errors) as f:
                    text = _clean_data(f.read())
                metadata = {"source": str(p)}
                docs.append(Document(page_content=text, metadata=metadata))
            return docs