Method prepare_settings

sphinx/environment/__init__.py:566–573

Prepare to set up environment for reading.

(self, docname: str)

    # --------- SINGLE FILE READING --------------------------------------------

    def prepare_settings(self, docname: str) -> None:
        """Prepare to set up environment for reading."""
        self.current_document = _CurrentDocument(
            docname=docname,
            # defaults to the global default, but can be re-set in a document
            default_role=self.config.default_role,
            default_domain=self.domains.get(self.config.primary_domain),
        )

    # utilities to use while reading a document