DocumenterInventoryWritingBackport.jl

DocumenterInventoryWritingBackport.jl is a backport of the inventory-writing feature in Documenter v1.3 to Documenter v0.25–v1.2.

See "Inventory Generation" in the DocumenterInterLinks documentation for details.

Installation

As usual, the package can be installed via

] add DocumenterInventoryWritingBackport

in the Julia REPL, or by adding

DocumenterInventoryWritingBackport = "195adf08-069f-4855-af3e-8933a2cdae94"

to the relevant Project.toml file (e.g., docs/Project.toml).

Usage

Add

using DocumenterInventoryWritingBackport

to a project's docs/make.jl file, or in the REPL where you are building the project's documentation. Then, build the documentation as normal.

Simply loading DocumenterInventoryWritingBackport in this way should be sufficient to ensure that an objects.inv inventory file will be created when building the documentation.