-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DISCUSSION] Set up documentation/website generator #26
Comments
I'm not an expert so I asked ChatGPT to search other alternatives for me:
|
ChatGPT misses again!
|
Doxygen might be the best option from all the information we have so far :) |
At the very least, most other solutions will use Doxygen as a base so I'll try and set it up |
I don't have any opinion on the C++ documentation generation, but we use mkdocs at PyIceberg, and it works really well: https://github.com/apache/iceberg-python/tree/main/mkdocs |
How does mkdocs compare to Sphinx? Sphinx really has excellent cross-referencing capabilities (to API docs, to glossary, to other pages, to index references, even to other Spinx docs). |
@pitrou It is pretty similar, mkdocs feels a bit more modern to me. Referencing the Python docs works pretty well: https://py.iceberg.apache.org/reference/pyiceberg/io/ |
How does it work for C++ though? I see a few random plugins (like cxxdox) but I'm not confident in them vs Doxygen. (I also don't see from a bit of searching how mkdocs handles the equivalent of a Sphinx |
There's already some question of where to put documentation: #24 (comment)
Some candidates:
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?
The text was updated successfully, but these errors were encountered: