From 04ac7a48447b884544d160ebee824ad571408c79 Mon Sep 17 00:00:00 2001 From: Nirbheek Chauhan Date: Mon, 17 Jul 2017 12:40:09 +0530 Subject: gnome.gtkdoc: Handle absolute install_dirs correctly Must prepend DESTDIR in case it's absolute. Also document that by default it is relative to the gtk-doc html directory. --- docs/markdown/Gnome-module.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/markdown/Gnome-module.md b/docs/markdown/Gnome-module.md index e709fd5..d01deaf 100644 --- a/docs/markdown/Gnome-module.md +++ b/docs/markdown/Gnome-module.md @@ -136,14 +136,14 @@ Note that very old versions of yelp may not support symlinked media; At least 3. ### gnome.gtkdoc() -Compiles and installs gtkdoc documentation. Takes one positional arguments; The name of the module. +Compiles and installs gtkdoc documentation into `prefix/share/gtk-doc/html`. Takes one positional argument: The name of the module. * `main_xml`: specifies the main XML file * `main_sgml`: equal to `main_xml` * `src_dir`: include_directories to include * `dependencies`: a list of dependencies * `install`: if true, installs the generated docs -* `install_dir`: the directory to install the generated docs +* `install_dir`: the directory to install the generated docs relative to the gtk-doc html dir or an absolute path (default: module name) * `scan_args`: a list of arguments to pass to `gtkdoc-scan` * `scanobjs_args`: a list of arguments to pass to `gtkdoc-scangobj` * `gobject_typesfile`: a list of type files -- cgit v1.1