sphinx/doc/extdev/builderapi.rst

.. _writing-builders:

Builder API
===========

.. todo:: Expand this.

.. currentmodule:: sphinx.builders

.. class:: Builder

   This is the base class for all builders.

   These attributes should be set on builder classes:

   .. autoattribute:: name
   .. autoattribute:: format
   .. autoattribute:: epilog
   .. autoattribute:: supported_image_types
   .. autoattribute:: supported_remote_images
   .. autoattribute:: supported_data_uri_images
   .. autoattribute:: default_translator_class

   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
Expand on the pickle builder. 2008-03-25 19:20:26 +00:00			`.. _writing-builders:`

Doc: move API docs in their own chapter and add more of it. 2014-01-20 17:21:44 +01:00			`Builder API`
			`===========`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00
Add todo extension. 2008-11-09 19:46:32 +01:00			`.. todo:: Expand this.`
Add license and repository info to front page, add comments where sections need to be written. 2008-03-21 18:59:28 +00:00
Some more fixes after the great renaming. 2008-11-29 20:04:11 +01:00			`.. currentmodule:: sphinx.builders`
Fix class name. 2008-06-18 18:46:46 +00:00
			`.. class:: Builder`
Update documentation, add more content. 2008-03-16 11:19:26 +00:00
			`This is the base class for all builders.`

Do not include the builder class in the entry point - use the entry point to load the extension module in the usual way - update the documentation to reflect this change 2017-04-14 11:01:09 +02:00			`These attributes should be set on builder classes:`

			`.. autoattribute:: name`
			`.. autoattribute:: format`
builders: Add 'Builder.epilog' option This allows builders to emit a final epilog message containing information such as where resulting files can be found. This is only emitted if the build was successful. This allows us to remove this content from the 'make_mode' tool and the legacy 'Makefile' and 'make.bat' templates. There's room for more dramatic simplification of the former, but this will come later. Signed-off-by: Stephen Finucane <stephen@that.guru> 2017-12-28 20:45:02 +00:00			`.. autoattribute:: epilog`
Do not include the builder class in the entry point - use the entry point to load the extension module in the usual way - update the documentation to reflect this change 2017-04-14 11:01:09 +02:00			`.. autoattribute:: supported_image_types`
docs: Add description for attributes of Builder (refs: #4402) 2018-01-29 22:40:49 +09:00			`.. autoattribute:: supported_remote_images`
			`.. autoattribute:: supported_data_uri_images`
			`.. autoattribute:: default_translator_class`
Do not include the builder class in the entry point - use the entry point to load the extension module in the usual way - update the documentation to reflect this change 2017-04-14 11:01:09 +02:00
Update documentation, add more content. 2008-03-16 11:19:26 +00:00			`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`

Improve builder docs a bit. 2008-12-26 20:17:59 +01:00			`These methods can be overridden in concrete builder classes:`
Update documentation, add more content. 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`
Improve builder docs a bit. 2008-12-26 20:17:59 +01:00