diff --git a/sphinx/builders/__init__.py b/sphinx/builders/__init__.py index 15ac62c7a..c153d1210 100644 --- a/sphinx/builders/__init__.py +++ b/sphinx/builders/__init__.py @@ -385,9 +385,11 @@ class Builder(object): t.join() def prepare_writing(self, docnames): + """A place where you can add logic before :meth:`write_doc` is run""" raise NotImplementedError def write_doc(self, docname, doctree): + """Where you actually write something to the filesystem.""" raise NotImplementedError def write_doc_serialized(self, docname, doctree):