Skip to content

Add ezgl Doxygen api documentation to to the VTR docs #3036

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

Open
vaughnbetz opened this issue May 13, 2025 · 0 comments · May be fixed by #3045
Open

Add ezgl Doxygen api documentation to to the VTR docs #3036

vaughnbetz opened this issue May 13, 2025 · 0 comments · May be fixed by #3045
Assignees

Comments

@vaughnbetz
Copy link
Contributor

Proposed Behaviour

EZGL's api should be documented under the vtr documentation.

Current Behaviour

EZGL is documented with doxygen, but we aren't building or linking its documentation into the VTR read the docs pages.

Possible Solution

Build the ezgl doxygen html docs as part of the documentation build. Put a new EZGL tab under vtrutil api.

There is a tutorial on how to add new tabs to our docs at https://docs.verilogtorouting.org/en/latest/dev/code_documentation/#validation-of-doxygen-comments-updating-api-reference
(it is probably not as easy to follow as it could be -- you can update it if you determine it is hard to follow!).
We build the documentation on each pull request, so the easiest way to check if the documentation built properly is just to make a PR and check (you can click on the documentation test link in the PR). That should also be added to the tutorial / doxygen guide; you could do that as part of this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants