diff options
Diffstat (limited to 'doc/extdev/builderapi.rst')
| -rw-r--r-- | doc/extdev/builderapi.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/extdev/builderapi.rst b/doc/extdev/builderapi.rst new file mode 100644 index 000000000..cd8688a36 --- /dev/null +++ b/doc/extdev/builderapi.rst @@ -0,0 +1,30 @@ +.. _writing-builders: + +Builder API +=========== + +.. todo:: Expand this. + +.. currentmodule:: sphinx.builders + +.. class:: Builder + + This is the base class for all builders. + + These methods are predefined and will be called from the application: + + .. automethod:: get_relative_uri + .. automethod:: build_all + .. automethod:: build_specific + .. automethod:: build_update + .. automethod:: build + + These methods can be overridden in concrete builder classes: + + .. automethod:: init + .. automethod:: get_outdated_docs + .. automethod:: get_target_uri + .. automethod:: prepare_writing + .. automethod:: write_doc + .. automethod:: finish + |