MCPcopy
hub / github.com/sphinx-doc/sphinx / write_documents

Method write_documents

sphinx/builders/__init__.py:750–762  ·  view source on GitHub ↗

Write all documents in *docnames*. This method can be overridden if a builder does not create output files for each document.

(self, docnames: Set[str])

Source from the content-addressed store, hash-verified

748 self.write_documents(docnames)
749
750 def write_documents(self, docnames: Set[str]) -> None:
751 """Write all documents in *docnames*.
752
753 This method can be overridden if a builder does not create
754 output files for each document.
755 """
756 sorted_docnames = sorted(docnames)
757 if self.parallel_ok:
758 # number of subprocesses is parallel-1 because the main process
759 # is busy loading doctrees and doing write_doc_serialized()
760 self._write_parallel(sorted_docnames, nproc=self._app.parallel - 1)
761 else:
762 self._write_serial(sorted_docnames)
763
764 def _write_serial(self, docnames: Sequence[str]) -> None:
765 with (

Callers 1

writeMethod · 0.95

Calls 2

_write_parallelMethod · 0.95
_write_serialMethod · 0.95

Tested by

no test coverage detected