Files
libloot/docs
Oliver Hamlet f217904715 Update dependency notices
I forgot to do this before the last release.
2025-10-10 23:31:05 +01:00
..
2025-10-10 23:31:05 +01:00
2025-06-11 19:06:08 +01:00
2025-06-11 19:06:09 +01:00
2025-06-15 20:12:24 +01:00
2025-10-09 18:20:01 +01:00

libloot Documentation

This directory contains documentation for libloot and LOOT's metadata syntax. It does not include Rust API reference documentation: that is generated using cargo doc.

To build the documentation, install Python and uv and make sure they're accessible from your PATH, then run:

uv run -- sphinx-build -b html . build/html

If Doxygen is also installed and accessible from your PATH, the C++ API's reference documentation will also be included.

The files for dependency licenses and copyright notices are auto-generated. The script is hardcoded to generate files for the C++ wrapper's dependencies, but in practice that doesn't add any content over doing the same for just the core libloot Rust library.

To regenerate the generated files, first install cargo-attribution then run scripts/licenses.py, e.g. py scripts/licenses.py or python3 scripts/licenses.py.