Skip to content
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

Open
mithro opened this issue Aug 4, 2020 · 4 comments
Open

Set up sphinx + doxygen documentation generation #379

mithro opened this issue Aug 4, 2020 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@mithro
Copy link
Collaborator

mithro commented Aug 4, 2020

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
Copy link
Collaborator Author

mithro commented Aug 4, 2020

Related issues;

Demo documents;

@fangism fangism added the documentation Improvements or additions to documentation label Aug 4, 2020
@mithro
Copy link
Collaborator Author

mithro commented Sep 28, 2020

FYI -- @rw1nkler

@mithro
Copy link
Collaborator Author

mithro commented Sep 28, 2020

@rw1nkler
Copy link

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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants