blob: adc41016ecdaa959c134ad2979ff6e9a55b77025 (
plain)
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:
Writing new builders
====================
.. todo:: Expand this.
.. currentmodule:: sphinx.builder
.. class:: 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
|