tomtom-international / asciidoxy

AsciiDoxy generates API documentation from Doxygen XML output to AsciiDoc.
Apache License 2.0
31 stars 10 forks source link

Can't include packages with the new contents.toml format #27

Closed jenswet closed 3 years ago

jenswet commented 3 years ago

Hello!

I just tried to update from 0.6.3 to 0.7.0. The new package format does not seem to work for me. I always get this error:

asciidoxy.packaging.collect.SpecificationError: Invalid specification: Package embedded-node, or its source, has no `xml_subdir`.

I did the following:

[asciidoc] src_dir = "adoc"

[reference] type = "doxygen" dir = "xml"

- I have a folder `doc-builder` containing the `Main.adoc` and the `packages.spec`:

[packages] [packages.embedded-node] type = "local" package_dir = "/builds/some-path-to/docs"


- I try to execute `asciidoxy --spec-file packages.spec Main.adoc --multipage`

It doesn't seem to recognize the new `contents.toml`.

Is it a bug or did I understand the documentation wrong?

Thanks and regards!
RobvanderMost-TomTom commented 3 years ago

Thank you for reporting this issue. I indeed forgot to update the package spec reader. The xml_subdir and include_subdir properties should no longer be mandatory. I will address this in the next patch release.

As a workaround, you can provide dummy values for both xml_subdir and include_subdir in the package specification file. They will be ignored for packages containing contents.toml