Merge pull request #218 from mesonbuild/gtkdoc

Basic gtkdoc support

1 files changed, 80 insertions, 0 deletions

diff --git a/gtkdochelper.py b/gtkdochelper.py
new file mode 100755
index 0000000..f27b2b5
--- /dev/null
+++ b/gtkdochelper.py
@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+# Copyright 2015 The Meson development team
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+
+#     http://www.apache.org/licenses/LICENSE-2.0
+
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import sys, os
+import subprocess
+import shutil
+
+def build_gtkdoc(source_root, build_root, doc_subdir, src_subdir, main_sgml, module):
+    abs_src = os.path.join(source_root, src_subdir)
+    abs_out = os.path.join(build_root, doc_subdir)
+    htmldir = os.path.join(abs_out, 'html')
+    subprocess.check_call(['gtkdoc-scan',
+                           '--module=' + module,
+                           '--source-dir=' + abs_src,
+                           '--output-dir=.'], cwd=abs_out)
+    mkdb_cmd = ['gtkdoc-mkdb',
+                '--module=' + module,
+                '--output-format=xml',
+                '--sgml-mode',
+                '--source-dir=' + abs_src]
+    sgml_abs = os.path.join(source_root, doc_subdir, main_sgml)
+    if len(main_sgml) > 0:
+        mkdb_cmd.append('--main-sgml-file=' + sgml_abs)
+    subprocess.check_call(mkdb_cmd, cwd=abs_out)
+    shutil.rmtree(htmldir, ignore_errors=True)
+    try:
+        os.mkdir(htmldir)
+    except Exception:
+        pass
+    mkhtml_cmd = ['gtkdoc-mkhtml', module]
+    if len(main_sgml) > 0:
+        # Workaround for
+        # https://bugzilla.gnome.org/show_bug.cgi?id=753145
+        plainfile = os.path.split(sgml_abs)[1]
+        shutil.copy(sgml_abs, os.path.join(abs_out, plainfile))
+        mkhtml_cmd.append('../' + plainfile)
+    else:
+        mkhtml_cmd.append('../%s-docs.xml' % module)
+    subprocess.check_call(mkhtml_cmd, cwd=htmldir, shell=False)
+    subprocess.check_call(['gtkdoc-fixxref',
+                           '--module=' + module,
+                           '--module-dir=html'], cwd=abs_out)
+
+def install_gtkdoc(build_root, doc_subdir, install_prefix, datadir, module):
+    source = os.path.join(build_root, doc_subdir, 'html')
+    final_destination = os.path.join(install_prefix, datadir, module)
+    shutil.rmtree(final_destination, ignore_errors=True)
+    shutil.copytree(source, final_destination)
+
+if __name__ == '__main__':
+#    source_root = '/home/jpakkane/workspace/meson/test cases/frameworks/10 gtk-doc'
+#    build_root = '/home/jpakkane/workspace/meson/work area'
+#    doc_subdir = 'doc'
+#    src_subdir = 'include'
+#    module = 'foobar'
+    if len(sys.argv) != 7:
+        print(sys.argv)
+        print("Bad arguments.")
+        sys.exit(1)
+    (source_root, build_root, doc_subdir, src_subdir, main_sgml, module) = sys.argv[1:]
+    build_gtkdoc(source_root, build_root, doc_subdir, src_subdir, main_sgml, module)
+
+    if 'MESON_INSTALL_PREFIX' in os.environ:
+        if 'DESTDIR' in os.environ:
+            installdir = os.environ['DESTDIR'] + os.environ['MESON_INSTALL_PREFIX']
+        else:
+            installdir = os.environ['MESON_INSTALL_PREFIX']
+        install_gtkdoc(build_root, doc_subdir, installdir, 'share/gtk-doc/html', module)