Document C code

We should make documentation of the C code in cocotb/lib/ available in Sphinx. There are Doxygen annotations (though incomplete, see #8) in some of the files, so we might want to use https://breathe.readthedocs.io/en/latest/ (a Doxygen -> Sphinx bridge).

Some other links/examples:

• http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#cross-referencing-c-constructs
• https://docs.scipy.org/doc/numpy-1.15.0/reference/c-api.types-and-structures.html
  • https://raw.githubusercontent.com/sunny11mind/NumPy/master/doc/source/reference/c-api.types-and-structures.rst

[wallento]

I like the idea. Just to add to the examples: https://github.com/optimsoc/optimsoc/tree/master/doc/api

IIRC, breathe is broken and/or unmaintained with recent sphinx, but its easy to workaround…

[cmarqu]

This is now live at https://cocotb.readthedocs.io/en/latest/library_reference_c.html