yosys-f4pga-plugins icon indicating copy to clipboard operation
yosys-f4pga-plugins copied to clipboard

Make sure that all plugins have nice auto-generated documentation in Sphinx

Open mithro opened this issue 4 years ago • 3 comments

All the plugins should have nice documentation published on Sphinx.

mithro avatar Nov 24 '20 18:11 mithro

@rw1nkler - What is the correct approach for this repo which is mostly C code? Something like the Verilog to Routing set up?

mithro avatar Nov 24 '20 18:11 mithro

@tmichalak -- Who should take on this work?

mithro avatar Nov 24 '20 18:11 mithro

@rw1nkler - What is the correct approach for this repo which is mostly C code? Something like the Verilog to Routing set up?

A Sphinx setup for C/C++ code is simple. I can prepare it for this repository. The most important part is to document the code using Doxygen code comments.

rw1nkler avatar Nov 24 '20 18:11 rw1nkler