mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-01-18 05:16:05 +00:00
Code Issues 1 Projects Releases Wiki Activity

README: Add section how to build and visualize documentation

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/3442>
This commit is contained in:
Xavier Claessens 2022-11-21 11:38:39 -05:00 committed by GStreamer Marge Bot
parent ef73db4210
commit 949b12c7f5
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -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 This is an experimental feature, backward incompatible changes could still be
made in the future. 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
## Development environment target ## Development environment target