tag/0.28.2/docs/README.md

# 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](https://www.python.org/) and [uv](https://docs.astral.sh/uv/getting-started/installation/) and make sure they're accessible from your `PATH`, then run:

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

If [Doxygen](https://www.doxygen.nl/) 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](https://github.com/ameknite/cargo-attribution) then run `scripts/licenses.py`, e.g. `py scripts/licenses.py` or `python3 scripts/licenses.py`.
Move cpp/docs to docs 2025-06-11 17:58:02 +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`.

Improve readmes 2025-06-15 20:12:24 +01:00			To build the documentation, install [Python](https://www.python.org/) and [uv](https://docs.astral.sh/uv/getting-started/installation/) and make sure they're accessible from your `PATH`, then run:
Move cpp/docs to docs 2025-06-11 17:58:02 +01:00
			```
			`uv run -- sphinx-build -b html . build/html`
			```

Make building C++ API docs optional 2025-06-11 18:59:59 +01:00			If [Doxygen](https://www.doxygen.nl/) is also installed and accessible from your `PATH`, the C++ API's reference documentation will also be included.

Improve readmes 2025-06-15 20:12:24 +01:00			`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](https://github.com/ameknite/cargo-attribution) then run `scripts/licenses.py`, e.g. `py scripts/licenses.py` or `python3 scripts/licenses.py`.