lidavidm opened a new issue, #26: URL: https://github.com/apache/iceberg-cpp/issues/26
There's already some question of where to put documentation: https://github.com/apache/iceberg-cpp/pull/24#discussion_r1911861722 Some candidates: - [Doxygen](https://www.doxygen.nl/) handles C++ nicely and can scrape docstrings. It can also generate a website, not just API docs, and accepts a limited amount of Markdown. IMO, however, it doesn't look very pretty (though you can [theme](https://jothepro.github.io/doxygen-awesome-css/index.html) it). - [Sphinx](https://www.sphinx-doc.org/en/master/) while primarily used for Python can also handle C++ and is easily extensible. It does not scrape docstrings. It can render Doxygen-generated docstrings via a [plugin](https://github.com/breathe-doc/breathe) but IMO this does not look very nice, loses some of the structure that Doxygen has, and the plugin seems to be minimally maintained/unmaintained (for a while it required a rather outdated version of Sphinx). It can render Markdown through a [plugin](https://myst-parser.readthedocs.io/en/latest/index.html) (though it will be Sphinx-flavored Markdown). We could also go with separate documentation/website generators, in which case we could pull in Jekyll/Hugo/Quarto/Sphinx/[insert your favorite yak shave of choice here]. Has anyone worked with any other tools? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
