search

tomtom-international / asciidoxy

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

Have you considered antora jointly with asciidoxy ? #36

Open prudhomm opened 3 years ago

prudhomm commented 3 years ago

Antora is a documentation site generator using asciidoc and asciidoctor. Have you considered using asciidoxy to generated a component for Antora ? Some discussions here https://antora.zulipchat.com/#narrow/stream/282400-users/topic/thoughts.20on.20antora.20for.20automated.20reference.20documentation.20.2E.2E.2E (antora zulip chat) after I discovered asciidoxy. It seems that asciidoxy would be a nice candidate to generate automatically documentation from doxygen and publish it with antora

silvester747 commented 2 years ago

The new feature to generate AsciiDoc output instead of running AsciiDoctor may already make it easier to integrate with Antora. I still have to see what is required for more close integration.

prudhomm commented 2 years ago

@silvester747 any updates on this?

antora has some new tools and extension system that could make it even easier to deal with automated code generation

prudhomm commented 2 years ago

@silvester747 in antora there is now an extension called collector that could be used to collect the intermediate adoc files generated by asciidoxy and incorporate them in an antora site. The adoc generation is deleguated to asciidoxy and then aggregated into the contentCatalog of antora by the collector extension. i think that could be worth a try