Available under libvmi.com.
source- default branch with the source code, pull requests/changes should be submitted to this branch;master- the actual content of the web page; this branch contains static HTML which is automatically generated fromsourceand shouldn't be edited directly, see .github/workflows/main.yml for reference.
The API documentation at libvmi.com/api/ is generated automatically in such way:
- Latest version of
libvmi/libvmibranchmasteris fetched. - Doxygen is ran in
libvmi/directory (the one which containslibvmi.hand other exported headers). - Doxygen's XML output file
libvmi_8h.xmlis parsed by parse-doxygen-xml.py script from this repository. - The output of the above script is saved under
api/index.htmlfile.
API docs are re-generated periodically by the Continous Integration, to ensure they are up to date with the latest version of LibVMI.
Pull requests should be done to the default source branch. Once you submit a PR, a GitHub Actions will perform a dry-run of the content generation process. You can check how the page would look like after your PR by inspecting the artifacts generated by GitHub Actions workflow.
