IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation to the undocumented builder methods.

Browse Source
This commit is contained in:
Eric Holscher 2013-07-02 22:58:34 -07:00
parent 3cd2b24fc5
commit ec494bec07
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/builders/__init__.py
View File

@ -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):