Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

Fokko closed issue #26: [DISCUSSION] Set up documentation/website generator URL: https://github.com/apache/iceberg-cpp/issues/26 -- 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.

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

Fokko closed issue #26: [DISCUSSION] Set up documentation/website generator URL: https://github.com/apache/iceberg-cpp/issues/26 -- 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.

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

lidavidm commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2587189407 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

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

Fokko commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2587026463 @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/ -- This is a

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

pitrou commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2587019412 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)

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

Fokko commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2587009767 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 --

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

lidavidm commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2586895926 At the very least, most other solutions will use Doxygen as a base so I'll try and set it up -- This is an automated message from the Apache Git Service. To respond to the message

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

wgtmac commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2586350059 Doxygen might be the best option from all the information we have so far :) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to G

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

lidavidm commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2586291743 ChatGPT misses again! - Doxybook2 is no longer maintained. - docfx has no C++ support. We'd have to manually convert Doxygen output. - Standardese, maybe. It hasn't relea

Re: [I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

wgtmac commented on issue #26: URL: https://github.com/apache/iceberg-cpp/issues/26#issuecomment-2586192832 I'm not an expert so I asked ChatGPT to search other alternatives for me: | Name | Pros | Cons | Links | |--|--|--|---| | MkDocs with Doxybook2 | • Modern,

[I] [DISCUSSION] Set up documentation/website generator [iceberg-cpp]

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