1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 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
|