2008-03-25 19:20:26 +00:00
|
|
|
.. _writing-builders:
|
|
|
|
|
|
2008-03-16 11:19:26 +00:00
|
|
|
Writing new builders
|
|
|
|
|
====================
|
|
|
|
|
|
2008-11-09 19:46:32 +01:00
|
|
|
.. todo:: Expand this.
|
2008-03-21 18:59:28 +00:00
|
|
|
|
2008-11-29 20:04:11 +01:00
|
|
|
.. currentmodule:: sphinx.builders
|
2008-06-18 18:46:46 +00:00
|
|
|
|
|
|
|
|
.. class:: Builder
|
2008-03-16 11:19:26 +00:00
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
2008-12-26 20:17:59 +01:00
|
|
|
These methods can be overridden in concrete builder classes:
|
2008-03-16 11:19:26 +00:00
|
|
|
|
|
|
|
|
.. automethod:: init
|
|
|
|
|
.. automethod:: get_outdated_docs
|
|
|
|
|
.. automethod:: get_target_uri
|
|
|
|
|
.. automethod:: prepare_writing
|
|
|
|
|
.. automethod:: write_doc
|
|
|
|
|
.. automethod:: finish
|
2008-12-26 20:17:59 +01:00
|
|
|
|
