Bug 83431 - Integrate a better protocol document generator
Summary: Integrate a better protocol document generator
Alias: None
Product: Wayland
Classification: Unclassified
Component: wayland (show other bugs)
Version: unspecified
Hardware: All All
: medium enhancement
Assignee: Wayland bug list
QA Contact:
Depends on:
Blocks: 83429
  Show dependency treegraph
Reported: 2014-09-03 10:23 UTC by Pekka Paalanen
Modified: 2018-06-04 08:17 UTC (History)
1 user (show)

See Also:
i915 platform:
i915 features:


Description Pekka Paalanen 2014-09-03 10:23:24 UTC
We could generate the documentation from XML files better.

An example is here: http://people.collabora.com/~jonny/protocol/
It has been generated with: https://github.com/jonnylamb/wayland-docs

Especially the cross-references are an excellent feature.

If we are happy with a Python dependency, we should import the generator and integrate it to the big docs both build and content/style wise.
Comment 1 Daniel Stone 2018-06-04 08:17:49 UTC
We do at least have cross-references, though they aren't great. The website in general probably needs some help.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.