DocInventories.jl is a package for reading and writing inventory files such as the objects.inv file written by Documenter.jl ≥ v1.3.0 and Sphinx.
These inventory files are used by DocumenterInterLinks.jl and Intersphinx to enable linking between the documentation of two projects.
The DocInventories package also allows to convert the objects.inv format to an inventory.toml format that is designed to be human-readable and to allow maintaining custom inventories by hand.
As usual, the package can be installed via
] add DocInventories
in the Julia REPL, or by adding
DocInventories = "43dc2714-ed3b-44b5-b226-857eda1aa7de"
to the relevant Project.toml file.
This package is primarily used in the context of DocumenterInterLinks.jl. For direct usage, see the Usage section in the documentation.
- Documenter.jl — The default documentation generator in the Julia ecosystem. As of version
1.3.0,Documenterautomatically generates and deploys a (Sphinx-format)objects.invfile that enables linking into a project's documentation. - DocumenterInterLinks.jl – A plugin for
Documenterto enable linking to any other project that has an inventory file, i.e., any project using a recent version ofDocumenterto build its documentation, or any project using Sphinx. It is the Julia-equivalent of Sphinx' Intersphinx plugin. - Sphinx – The default documentation generator in the Python ecosystem. Sphinx originated the
objects.invinventory file format now also generated for Julia projects byDocumenter. - sphobjinv – The Python-equivalent of this project, allowing to read, explore and manipulate the data in
objects.invinventory file. Note that this does not include support for theinventory.tomlformat, which is unique toDocInventories.