2008-03-25 14:20:26 -05:00
|
|
|
.. _writing-builders:
|
|
|
|
|
|
2008-03-16 06:19:26 -05:00
|
|
|
Writing new builders
|
|
|
|
|
====================
|
|
|
|
|
|
2008-03-21 13:59:28 -05:00
|
|
|
XXX to be expanded.
|
|
|
|
|
|
2008-03-16 06:19:26 -05:00
|
|
|
.. class:: sphinx.builder.Builder
|
|
|
|
|
|
|
|
|
|
This is the base class for all builders.
|
|
|
|
|
|
|
|
|
|
These methods are predefined and will be called from the application:
|
|
|
|
|
|
|
|
|
|
.. automethod:: load_env
|
|
|
|
|
.. automethod:: get_relative_uri
|
|
|
|
|
.. automethod:: build_all
|
|
|
|
|
.. automethod:: build_specific
|
|
|
|
|
.. automethod:: build_update
|
|
|
|
|
.. automethod:: build
|
|
|
|
|
|
|
|
|
|
These methods must be overridden in concrete builder classes:
|
|
|
|
|
|
|
|
|
|
.. automethod:: init
|
|
|
|
|
.. automethod:: get_outdated_docs
|
|
|
|
|
.. automethod:: get_target_uri
|
|
|
|
|
.. automethod:: prepare_writing
|
|
|
|
|
.. automethod:: write_doc
|
|
|
|
|
.. automethod:: finish
|
