search

lip6 / coriolis

Coriolis VLSI EDA Tool (LIP6)
https://coriolis.lip6.fr
GNU General Public License v2.0
47 stars 5 forks source link

Python API documentation needs to exist... #60

Open robtaylor opened 10 months ago

robtaylor commented 10 months ago

Currently for most of the python API, you need to look at the corresponding C++ api to figure it out. This should change!

Questions on how best to do this - can we use docstrings with the custom python module mapping? Can sphinx work with that? Will we be able to support document introspection of the extensions?

jpc-lip6 commented 10 months ago

That will need a bit of thinking. I dislike doing things twice, but we may need to duplicate the doc, one for C++, the other for Python. Note that the Python API is a subset, and some concepts still need to be presented in the doc. I was using sphinx, then I switched to pelican to have something more like a website. My ideal goal would be to have one tool to generate the documentation and that it could be turned into or presented as a website.

mithro commented 10 months ago

Sphinx supports importing doxygen style C++ API docs using exhale (https://exhale.readthedocs.io/en/latest/). The Verilog to Routing project (https://docs.verilogtorouting.org/) uses it.

robtaylor commented 10 months ago

Oh that's brilliant, thanks @mithro !