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.

Sign up for GitHub

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

Jump to bottom

Auto-generate documentation #439

Open

mithro opened this issue Oct 20, 2017 · 1 comment

Assignees

Labels

feature-request

Contributor

mithro commented Oct 20, 2017

It would be good if there was some auto-generated documentation for Yosys like these ones for VTR.

My suggestion is to make docs generated with Sphinx and probably Breathe. This works by having standard Doxygen style comments in your C++ code.

If this option is chosen, then the documentation can be auto generated on readthedocs.

Thoughts?

Collaborator

cliffordwolf commented Oct 20, 2017

About 80 pages of the manual are auto-generated documentation (Appendix C), so is the command reference on the web page: http://www.clifford.at/yosys/documentation.html (scroll down)

cliffordwolf assigned mithro

povik added the feature-request label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment