chipsalliance / verible

Verible is a suite of SystemVerilog developer tools, including a parser, style-linter, formatter and language server
https://chipsalliance.github.io/verible/
Other
1.26k stars 197 forks source link

Set up sphinx + doxygen documentation generation #379

Open mithro opened 3 years ago

mithro commented 3 years ago

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.

mithro commented 3 years ago

Related issues;

Demo documents;

mithro commented 3 years ago

FYI -- @rw1nkler

mithro commented 3 years ago

@rw1nkler set this up for the VerilogToRouting repository and it can be seen at https://docs.verilogtorouting.org/en/latest/api/vpr/contexts/

rw1nkler commented 3 years ago

Some useful resources for adding Sphinx+Breathe integration (C/C++ support):