Ideas: Documentation

• developers.google.com/season-of-docs
• Development
  • libghdl. How to interact with GHDL through libghdl and/or libghdl-py. (#1437, #1445, #1449)
  • Related Projects. Brief discussion about similarities/differences with other open source projects such as rust_hdl or pyVHDLParser.
• Usage
  • Docker.
    • Probably copy/convert README.md and USE_CASES.md in ghdl/docker (#166).
  • Language Server.
  • Examples
    • Learning VHDL with GHDL
      • UART. Dossmatik's UART and unisim guides. We have *.doc sources to be converted to Sphinx.
      • Coverage. Code coverage in GHDL is a side effect of using GCC as a backend. In the future, GCC backend support might be dropped in favour of mcode and LLVM. To do so, code coverage with LLVM should be supported first. Anyway, comments/bits of info should be gathered somewhere in the docs, along with references to gcov, lcov, etc.
    • It is possible to add waveforms in the docs with wavedrom, since there is a sphinx extension available.