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.application.Sphinx, env: sphinx.environment.BuildEnvironment)

Bases: DummyBuilder

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

epilog: ClassVar[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: ClassVar[str] = 'inventory'

The output-format identifier used by the inventory 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: ClassVar[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)