class documentation
class XMLBuilder(Builder): (source)
Known subclasses: sphinx.builders.xml.PseudoXMLBuilder
Builds Docutils-native XML.
Method | finish |
Finish the building process. |
Method | get |
Return an iterable of output files that are outdated, or a string describing what an update build will build. |
Method | get |
Return the target URI for a document name. |
Method | init |
Load necessary templates and perform initialization. The default implementation does nothing. |
Method | prepare |
A place where you can add logic before :meth:`write_doc` is run |
Method | write |
Where you actually write something to the filesystem. |
Class Variable | allow |
Undocumented |
Class Variable | epilog |
Undocumented |
Class Variable | format |
Undocumented |
Class Variable | name |
Undocumented |
Class Variable | out |
Undocumented |
Instance Variable | writer |
Undocumented |
Inherited from Builder
:
Method | __init__ |
Undocumented |
Method | build |
Main build method. |
Method | build |
Build all source files. |
Method | build |
Only rebuild as much as needed for changes in the *filenames*. |
Method | build |
Only rebuild what was changed or added since last build. |
Method | cleanup |
Cleanup any resources. |
Method | compile |
Undocumented |
Method | compile |
Undocumented |
Method | compile |
Undocumented |
Method | compile |
Undocumented |
Method | create |
Return the template bridge configured. |
Method | create |
Return an instance of translator. |
Method | get |
Return list of paths for assets (ex. templates, CSS, etc.). |
Method | get |
Return a builder specific option. |
Method | get |
Return a relative URI between two source filenames. |
Method | get |
Return a class of translator. |
Method | post |
Pick the best candidate for all image URIs. |
Method | read |
(Re-)read all files new or changed since last update. |
Method | read |
Parse a file and add/update inventory entries for the doctree. |
Method | set |
Store BuildEnvironment object. |
Method | write |
Undocumented |
Method | write |
Handle parts of write_doc that must be called in the main process if parallel build is active. |
Method | write |
Write the doctree to a file. |
Class Variable | default |
Undocumented |
Class Variable | supported |
Undocumented |
Class Variable | supported |
Undocumented |
Class Variable | supported |
Undocumented |
Class Variable | use |
Undocumented |
Class Variable | versioning |
Undocumented |
Class Variable | versioning |
Undocumented |
Instance Variable | app |
Undocumented |
Instance Variable | confdir |
Undocumented |
Instance Variable | config |
Undocumented |
Instance Variable | doctreedir |
Undocumented |
Instance Variable | env |
Undocumented |
Instance Variable | events |
Undocumented |
Instance Variable | finish |
Undocumented |
Instance Variable | imagedir |
Undocumented |
Instance Variable | images |
Undocumented |
Instance Variable | imgpath |
Undocumented |
Instance Variable | outdir |
Undocumented |
Instance Variable | parallel |
Undocumented |
Instance Variable | srcdir |
Undocumented |
Instance Variable | tags |
Undocumented |
Instance Variable | templates |
Undocumented |
Method | _read |
Undocumented |
Method | _read |
Undocumented |
Method | _write |
Undocumented |
Method | _write |
Undocumented |
overrides
sphinx.builders.Builder.finish
Finish the building process. The default implementation does nothing.
Return an iterable of output files that are outdated, or a string describing what an update build will build. If the builder does not output individual files corresponding to source files, return a string here. If it does, return an iterable of those files that need to be written.
Returns | |
Iterator[ | Undocumented |
overrides
sphinx.builders.Builder.init
Load necessary templates and perform initialization. The default implementation does nothing.
overrides
sphinx.builders.Builder.epilog
overridden in
sphinx.builders.xml.PseudoXMLBuilder
Undocumented
overrides
sphinx.builders.Builder.format
overridden in
sphinx.builders.xml.PseudoXMLBuilder
Undocumented
overrides
sphinx.builders.Builder.name
overridden in
sphinx.builders.xml.PseudoXMLBuilder
Undocumented