Skip to content
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

Doxygen documentation regeneration #243

Closed
vgvassilev opened this issue Apr 29, 2024 · 5 comments
Closed

Doxygen documentation regeneration #243

vgvassilev opened this issue Apr 29, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation to-fix

Comments

@vgvassilev
Copy link
Contributor

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
Copy link
Collaborator

mcbarton commented May 3, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@aaronj0 aaronj0 added the documentation Improvements or additions to documentation label May 16, 2024
Copy link
Contributor

github-actions bot commented Dec 5, 2024

This issue is stale because it has been open for 90 days with no activity.

@github-actions github-actions bot added the stale label Dec 5, 2024
@mcbarton mcbarton added to-fix and removed stale labels Dec 6, 2024
@mcbarton
Copy link
Collaborator

mcbarton commented Dec 7, 2024

This was fixed by #381

@mcbarton mcbarton closed this as completed Dec 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation to-fix
Projects
None yet
Development

No branches or pull requests

3 participants