diff options
| author | Xavier Claessens <xavier.claessens@collabora.com> | 2022-11-21 11:38:39 -0500 |
|---|---|---|
| committer | GStreamer Marge Bot <gitlab-merge-bot@gstreamer-foundation.org> | 2022-12-02 15:41:32 +0000 |
| commit | 949b12c7f5179b3ac7c9850fda9f706d70b1dbdb (patch) | |
| tree | f02c7746ffb84956faf66ad7b0807e7c7cb572bc /README.md | |
| parent | ef73db42107739d5fb912afa4903ca506e3cf5fb (diff) | |
| download | gstreamer-949b12c7f5179b3ac7c9850fda9f706d70b1dbdb.tar.gz | |
README: Add section how to build and visualize documentation
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3442>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -222,6 +222,22 @@ This will cause the features/plugins that are not registered to not be included This is an experimental feature, backward incompatible changes could still be made in the future. +### Building documentation + +Documentation is not built by default because it is slow to generate. To build +the documentation, first ensure that `hotdoc` is installed and `doc` option is +enabled. For API documentation, gobject introspection must also be enabled. +The special target `gst-doc` can then be used to (re)generate the documentation. + +``` +pip install hotdoc +meson setup -Ddoc=enabled -Dintrospection=enabled builddir +ninja -C builddir gst-doc +``` + +NOTE: To visualize the documentation, `devhelp` can be run inside the development +environment (see below). + # Development environment ## Development environment target |