Inventory builder

A customized builder which only generates intersphinx “object.inv” inventory files. The documentation files are not written.

class sage_docbuild.ext.inventory_builder.InventoryBuilder(app: Sphinx, env: BuildEnvironment)

Bases: DummyBuilder

A customized builder which only generates intersphinx “object.inv” inventory files. The documentation files are not written.

epilog: str = 'The inventory file is in %(outdir)s.'

The message emitted upon successful build completion. This can be a printf-style template string with the following keys: outdir, project

finish()

Only write the inventory files.

format: str = 'inventory'

The builder’s output format, or ‘’ if no document output is produced. This is commonly the file extension, e.g. “html”, though any string value is accepted. The builder’s format string can be used by various components such as SphinxPostTransform or extensions to determine their compatibility with the builder.

get_outdated_docs()

Return an iterable of output files that are outdated.

get_target_uri(docname, typ=None)

Return the target URI for a document name.

name: str = 'inventory'

The builder’s name. This is the value used to select builders on the command line.

sage_docbuild.ext.inventory_builder.setup(app)