doc_builder

doc_builder.base

class doc_builder.base.BaseBuilder(version, force=False)

The Base for all Builders. Defines the API for subclasses.

Expects subclasses to define old_artifact_path, which points at the directory where artifacts should be copied from.

build(id=None, **kwargs)

Do the actual building of the documentation.

clean(**kwargs)

Clean the path where documentation will be built

force(**kwargs)

An optional step to force a build even when nothing has changed.

move(**kwargs)

Move the documentation from it’s generated place to its artifact directory.

doc_builder.backends

doc_builder.backends.sphinx

class doc_builder.backends.sphinx.BaseSphinx(*args, **kwargs)

The parent for most sphinx builders.

append_conf(**kwargs)

Modify the given conf.py file from a whitelisted user’s project.