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 = None)

Bases: DummyBuilder

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

epilog = 'The inventory files are 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 = 'inventory'

The builder’s output format, or ‘’ if no document output is produced.

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 = 'inventory'

The builder’s name, for the -b command line option.

sage_docbuild.ext.inventory_builder.setup(app)