search

compiler-research / CppInterOp

A Clang-based C++ Interoperability Library
Other
38 stars 20 forks source link

Doxygen documentation regeneration #243

Open vgvassilev opened 2 months ago

vgvassilev commented 2 months ago

Looks like our documentation does not pick up the doxygen style comments: https://cppinterop.readthedocs.io/en/latest/build/html/index.html

I am not sure if that's a feature or we are just not regenerating the documentation.

mcbarton commented 1 month ago

I think this could be added as part of the nightly builds on the ci. We could add something that builds the documentation, and pushes the changes to this webpage.

vgvassilev commented 1 month ago

I think this could be added as part of the nightly builds on the ci. We could add something that builds the documentation, and pushes the changes to this webpage.

I believe that was part of the readthedocs website infrastructure. I just was not sure if the problem was the way we build our documentation or if we are not triggering new builds.

In #246 we landed a new interface and it seems to be showing there which means we regenerate the documentation but we do not take the comments...

vgvassilev commented 1 month ago

We seem to have hit some bug because all interface documentation is attached to the attribute() : https://cppinterop.readthedocs.io/en/latest/build/html/namespaceCpp.html#a3ef57f5fc1b6bf7e59bc40e340fd2be6