[gtk-doc] docs: add a section to explain the basic build order
- From: Stefan Kost <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] docs: add a section to explain the basic build order
- Date: Sun, 27 Feb 2011 20:06:08 +0000 (UTC)
commit 3b088ad3d231ca2eb52d13f8538787c600d8ce41
Author: Stefan Kost <ensonic users sf net>
Date: Sun Feb 27 22:06:54 2011 +0200
docs: add a section to explain the basic build order
help/manual/C/gtk-doc-manual.xml | 38 +++++++++++++++++++++++++++++++++++++-
1 files changed, 37 insertions(+), 1 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index 385f7fb..830b583 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -379,7 +379,10 @@
The next sections describe what steps to perform to integrate GTK-Doc into
your project. Theses sections assume we work on a project called 'meep'.
This project contains a library called 'libmeep' and
- an end-user app called 'meeper'.
+ an end-user app called 'meeper'. We also assume you will be using autoconf
+ and automake. In addition section <link linkend="plain_makefiles">plain
+ makefiles or other build systems</link> will describe the basics needed to
+ work in a different build setup.
</para>
<sect1 id="settingup_docfiles">
@@ -619,6 +622,39 @@ make
</para>
</sect1>
+ <sect1 id="plain_makefiles">
+ <title>Integration with plain makefiles or other build systems</title>
+
+ <para>
+ In the case one does not want to use automake and therfore
+ <filename>gtk-doc.mak</filename> one will need to call the gtkdoc tools
+ in the right order in own makefiles (or other build tools).
+ </para>
+
+ <para>
+ <example><title>Documentation build steps</title>
+ <programlisting>
+<![CDATA[
+DOC_MODULE=meep
+// sources have changed
+gtkdoc-scan --module=$(DOC_MODULE) --source-dir=...
+gtkdoc-scangobj --module=$(DOC_MODULE)
+gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml
+// xml files have changed
+mkdir html
+cd html && gtkdoc-mkhtml $(DOC_MODULE) ../meep-docs.xml
+gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
+]]>
+ </programlisting>
+ </example>
+ </para>
+
+ <para>
+ One will need to look at the <filename>Makefile.am</filename> and
+ <filename>gtk-doc.mak</filename> to pick the extra options needed.
+ </para>
+ </sect1>
+
</chapter>
<chapter id="documenting">
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]