The Base for all Builders. Defines the API for subclasses. All workflow steps need to return true, otherwise it is assumed something went wrong and the Builder will stop
Do the actual building of the documentation.
Says whether the documentation has changed, and requires further action.
This is mainly used to short-circuit more expensive builds of other output formats if the project docs didn’t change on an update. Subclasses are recommended to override for more efficient builds.
Defaults to True
Clean up the version so it’s ready for usage.
This is used to add RTD specific stuff to Sphinx, and to implement whitelists on projects as well.
It is guaranteed to be called before your project is built.
An optional step to force a build even when nothing has changed.
Move the documentation from it’s generated place to its final home.
This needs to understand both a single server dev environment, as well as a multi-server environment.