Description
The exavmlib
documentation is not currently included in our published documentation.
The documentation build system is fairly complex, but essentially everything get built from markdown (or restructured text, aka .rst) files, so that it can have a unified Read-The-Docs theme. The Erlang module edocs are generated using edown
to produce the markdown output of the documentation, but I cannot find a similar method of producing markdown (or restructured text) files for the exavmlib
modules. There are other quirks, such as the specific anchor naming scheme that must be used for the myst
Sphinx plugin to generate html links for anchors (such as to functions, type specs, or other sections), but just getting the content included would be an improvement.
Any help or suggestions on how to include documentation for exavmlib
in the Read-the-Docs themed HTML that we publish would be greatly appreciated.