-
Notifications
You must be signed in to change notification settings - Fork 415
Add doxygen documentation of atom_netlist and clb_netlist to vpr API web documentation #1767
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
Comments
@rw1nkler - Any idea why these are not showing up? |
The derived classes need to be specified in the proper sphinx RST file, in the similar way as it is done for the base As it was stated, those files should be already parsed by Doxygen and references to them should be available in Sphinx. |
@rw1nkler or @MohamedElgammal : can one of you add the two derived classes in the appropriate spot? |
@rw1nkler @MohamedElgammal : nag, nag, nag ... It would be really nice to have these in the readthedocs pages, as I'd like to point some new developers at them. |
@vaughnbetz will handle this and mention you in the corresponding PR. |
Thanks @MohamedElgammal |
The base netlist class is documented in the vpr api documentation in read the docs, but the derived atom and clb netlists are not. Those netlists have doxygen-compatible comments already, so they should be added to the doxygen build settings in the documentation so they show up in the read-the-docs documentatin.
Proposed Behaviour
Doxygen comments (which already exist) should create new vpr api documentation on the vtr web page as sub-headings under the netlist documentation.
Current Behaviour
Currently the base netlist class has auto-generated documentation, but these derived classes do not.
Possible Solution
Update the Doxygen configuration to add these two classes.
Context
To ramp up new developers and expand our documentation we should get this on the web docs.
The text was updated successfully, but these errors were encountered: