Skip to content

Generate HTML documentation

Simon Ser requested to merge docs into main

Leverages gyosu to generate HTML documentation from the header files.

Example output: https://emersion.pages.freedesktop.org/-/libdisplay-info/-/jobs/29191368/artifacts/public/index.html ("back to index" links are broken because of index.html handling in artifacts)

I do realize that gyosu might not be the best pick, but I started it because I was unhappy with the other alternatives. I'd be totally fine dropping it if there are objections. In the spirit of the comparison in wayland/weston#216 (closed):

  • one-man project for now
  • more modern than kerneldoc
  • easy to install
  • small (1k LoC total), easy to hack
  • no advanced features
  • young, some features still missing

Merge request reports