Project API
***********

class sphinx.project.Project(srcdir: str, source_suffix: dict[str, str])

   A project is the source code set of the Sphinx document(s).

   discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) -> set[str]

      Find all document files in the source directory and put them in
      "docnames".

   doc2path(docname: str, basedir: bool = True) -> str

      Return the filename for the document name.

      If *basedir* is True, return as an absolute path. Else, return
      as a relative path to the source directory.

   path2doc(filename: str) -> str | None

      Return the docname for the filename if the file is a document.

      *filename* should be absolute or relative to the source
      directory.

   restore(other: Project) -> None

      Take over a result of last build.

   docnames: set[str]

      The name of documents belongs to this project.

   source_suffix

      source_suffix. Same as "source_suffix".

   srcdir

      Source directory.
