diff options
| author | Georg Brandl <georg@python.org> | 2014-01-20 17:21:44 +0100 |
|---|---|---|
| committer | Georg Brandl <georg@python.org> | 2014-01-20 17:21:44 +0100 |
| commit | 57f7239fc8a5dc0867da07e5c7b1dc023227deb6 (patch) | |
| tree | 3c719fca66c0bb1b98027f69aa0226d44dad6faa /doc/extdev/builderapi.rst | |
| parent | 2ce06ad6912442129e03910ffb1e4dd8fe89acfe (diff) | |
| download | sphinx-57f7239fc8a5dc0867da07e5c7b1dc023227deb6.tar.gz | |
Doc: move API docs in their own chapter and add more of it.
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 00000000..cd8688a3 --- /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 + |
