Method note_dependency

sphinx/environment/__init__.py:605–618

Add *filename* as a dependency of the current document. This means that the document will be rebuilt if this file changes. *filename* should be absolute or relative to the source directory.

(
        self, filename: str | os.PathLike[str], *, docname: str | None = None
    )

        return self.current_document.new_serial_number(category)

    def note_dependency(
        self, filename: str | os.PathLike[str], *, docname: str | None = None
    ) -> None:
        """Add *filename* as a dependency of the current document.

        This means that the document will be rebuilt if this file changes.

        *filename* should be absolute or relative to the source directory.
        """
        if docname is None:
            docname = self.docname
        # this will do the right thing when *filename* is absolute too
        filename = self.srcdir / filename
        self.dependencies.setdefault(docname, set()).add(filename)

    def note_included(self, filename: str | os.PathLike[str]) -> None:
        """Add *filename* as a included from other document.