-
Notifications
You must be signed in to change notification settings - Fork 199
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
Set up sphinx + doxygen documentation generation #379
Labels
documentation
Improvements or additions to documentation
Comments
Related issues; Demo documents;
|
FYI -- @rw1nkler |
@rw1nkler set this up for the VerilogToRouting repository and it can be seen at https://docs.verilogtorouting.org/en/latest/api/vpr/contexts/ |
Some useful resources for adding Sphinx+Breathe integration (C/C++ support): |
nikhiljha
pushed a commit
to nikhiljha/verible
that referenced
this issue
Sep 27, 2022
nikhiljha
pushed a commit
to nikhiljha/verible
that referenced
this issue
Sep 27, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We should publish verible documentation on ReadTheDocs using Sphinx.
For HDL related projects like google/skywater-pdk, prjxray and verilog-to-routing we have standardized on using Sphinx (and on C++ projects Doxygen stuff being pulled into Sphinx).
There is also sphinxcontrib-verilog-diagrams which renders nice diagrams from Verilog and sphinx_symbiflow_theme which renders the documentation in material design.
The text was updated successfully, but these errors were encountered: