chipsalliance
Publish API docs on readthedocs
Surelog should publish documentation on ReadTheDocs like all good packages.
See https://docs.readthedocs.io/en/stable/ on how to get started.
The docs should be published at https://surelog.readthedocs.io/
The most popular tool for doing documentation on ReadTheDocs is Sphinx. See https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
We have a couple of special Sphinx plugins to make it easier to use with Verilog -> http://sphinxcontrib-verilog-diagrams.readthedocs.io/
This is used on the python-symbiflow-v2x docs at https://python-symbiflow-v2x.readthedocs.io/en/latest/
There is also a bunch of useful information at https://github.com/SymbiFlow/ideas/issues/9
More useful links;
- https://breathe.readthedocs.io/en/latest/
- https://exhale.readthedocs.io/en/latest/
There was some work on this for SymbiFlow at https://github.com/SymbiFlow/symbiflow-docs
@rw1nkler and @mgielda from @antmicro might also be able to give some tips and hints.
@daniellimws might also be interested in helping out here. He has been doing some great work for other SymbiFlow related projects.
The idea at https://github.com/SymbiFlow/ideas/issues/49 could help with making this nice and easy.