diff --git a/docs/extract/index.md b/docs/extract/index.md index 6e320f3d738fbc7d7bc26a6db2af0e3e1cc61e62..0dce3d74a4e20eb15465fb14efe8ac549be81608 100644 --- a/docs/extract/index.md +++ b/docs/extract/index.md @@ -24,6 +24,4 @@ More details about the configuration file needed in the [Dataset extraction](./c There is an additional CLI argument `--format` that allows specifying the format of the export, if the default one doesn't suit the use case. Supported versions are: -- [pylaia](https://github.com/jpuigcerver/PyLaia) - -Some additional arguments are available and are described in the [Pylaia arguments](../ref/extract/pylaia/arguments.md#atr_data_generator.extract.pylaia.arguments.PylaiaArgs) section. +- [PyLaia](pylaia.md) diff --git a/docs/extract/pylaia.md b/docs/extract/pylaia.md new file mode 100644 index 0000000000000000000000000000000000000000..ab3d9098630c35d35dd19bb4ea476277f63af3b9 --- /dev/null +++ b/docs/extract/pylaia.md @@ -0,0 +1,12 @@ +## PyLaia dataset extraction + +To enable this output format, use the flag `--format pylaia`. The full command becomes: + +```sh +atr-data-generator extract \ + --config path/to/configuration.yaml \ + --database-path path/to/db.sqlite \ + --format pylaia +``` + +The available arguments are described in the [dedicated section](../ref/extract/pylaia/arguments.md#atr_data_generator.extract.pylaia.arguments.PylaiaArgs) of the Python API reference. diff --git a/mkdocs.yml b/mkdocs.yml index dbe4ee71ca9a682c863ab2770300f572e0ff6988..4c4b3676bf8d1dad472200431612f94801cd74e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -52,6 +52,7 @@ nav: - Dataset extraction: - extract/index.md - Configuration: extract/configuration.md + - PyLaia dataset extraction: extract/pylaia.md - Dataset split: - split/index.md - Configuration: split/configuration.md @@ -59,6 +60,7 @@ nav: - Common Arguments: ref/arguments.md - Dataset extraction: - Arguments: ref/extract/arguments.md + - PyLaia-specific arguments: ref/extract/pylaia/arguments.md - Dataset splitting: - Arguments: ref/split/arguments.md - Development: dev.md