[Bug 782176] meson: gstreamer-plugins docs are missing

GStreamer (GNOME Bugzilla) bugzilla at gnome.org
Tue Aug 14 22:53:35 UTC 2018


https://bugzilla.gnome.org/show_bug.cgi?id=782176

--- Comment #10 from Thibault Saunier <tsaunier at gnome.org> ---
So this is basically the infrastructure and how things work together currently:

In each module, we have a set of Hotdoc meson targets which build docs for
different components (1 per lib and 1 per plugin). Those are referenced by the
`libs_doc` and `plugins_doc` variables in the meson file so they can be
reused/referenced from outside the module (be aggregated in gst-docs).

In gst-build we have a list of built projects which is passed to gst-docs.

In gst-docs, we go over the list of built subprojects and retrieve the targets
for all the doc from the various subprojects, aggregating the documentation in
a single sitemap.

---

To build the GStreamer plugins documenation we have a `hotdoc-plugin-inspect`
binary which basically takes a list of plugins `.so` and outputs json. Then we
have a hotdoc-plugin that consumes the json, updates it with informations from
previous runs (I worked on making sure it is all ordered and stable) and
renders the documentation for the plugins. The json file doesn't contain the
doc from comments. Currently updating the json is done at the same time as
building the doc, it can easily be done in a dedicated run_target if
required/preferred (I am not sure it is a good idea).

-- 
You are receiving this mail because:
You are the QA Contact for the bug.
You are the assignee for the bug.


More information about the gstreamer-bugs mailing list