Skip to content

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

Closed
vaughnbetz opened this issue Jun 5, 2021 · 6 comments · Fixed by #1783
Closed
Assignees

Comments

@vaughnbetz
Copy link
Contributor

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.

@mithro
Copy link
Contributor

mithro commented Jun 6, 2021

@rw1nkler - Any idea why these are not showing up?

@rw1nkler
Copy link
Contributor

rw1nkler commented Jun 10, 2021

@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 Netlist class:
https://github.com/verilog-to-routing/vtr-verilog-to-routing/blob/master/doc/src/api/vpr/netlist.rst#classes

As it was stated, those files should be already parsed by Doxygen and references to them should be available in Sphinx.

@vaughnbetz
Copy link
Contributor Author

@rw1nkler or @MohamedElgammal : can one of you add the two derived classes in the appropriate spot?

@vaughnbetz
Copy link
Contributor Author

@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.

@MohamedElgammal
Copy link
Contributor

@vaughnbetz will handle this and mention you in the corresponding PR.

@vaughnbetz
Copy link
Contributor Author

Thanks @MohamedElgammal

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