doc: Simplify Doxygen integration (#32)

fix #31
datafusion-contrib · Aug 22, 2022 · 731a2b3 · 731a2b3
1 parent c0ed81e
commit 731a2b3
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 15 deletions.
diff --git a/doc/Doxyfile → doc/Doxyfile.in b/doc/Doxyfile → doc/Doxyfile.in
@@ -18,4 +18,6 @@ GENERATE_HTML = NO
 GENERATE_LATEX = NO
 GENERATE_LEGEND = NO
 GENERATE_XML = YES
+OPTIMIZE_OUTPUT_FOR_C = YES
+INPUT = @DATAFUSION_H@
 PROJECT_NAME = "DataFusion C"
diff --git a/doc/build.py b/doc/build.py
@@ -52,20 +52,15 @@
 source_reference = args.source_reference
 
 datafusion_gir = next((build_root / 'datafusion-glib').glob('DataFusion-*.gir'))
-doxygen_dir = build_root / 'doc' / 'doxygen'
-gi_docgen_config = build_root / 'doc' / 'glib' / 'gi-docgen.toml'
-html_dir = build_root / 'doc' / 'html'
-html_timestamp = build_root / 'doc' / 'html.timestamp'
-sphinx_build_dir = build_root / 'doc' / 'build'
+build_doc_dir = build_root / 'doc'
+gi_docgen_config = build_doc_dir / 'glib' / 'gi-docgen.toml'
+html_dir = build_doc_dir / 'html'
+sphinx_build_dir = build_doc_dir / 'build'
 
-shutil.rmtree(doxygen_dir, ignore_errors=True)
-os.makedirs(doxygen_dir, exist_ok=True)
-shutil.copy2(source_root / 'doc' / 'Doxyfile', doxygen_dir)
-shutil.copy2(build_root / 'datafusion.h', doxygen_dir)
-subprocess.run('doxygen', cwd=doxygen_dir, check=True)
+subprocess.run('doxygen', cwd=build_doc_dir, check=True)
 
 sphinx_env = os.environ.copy()
-sphinx_env['DOXYGEN_XML_DIR'] = str(doxygen_dir / 'xml')
+sphinx_env['DOXYGEN_XML_DIR'] = str(build_doc_dir / 'xml')
 sphinx_env['SWITCHER_VERSION'] = source_reference
 subprocess.run(['make',
                 '-f' + str(source_root / 'doc' / 'Makefile'),
@@ -76,7 +71,7 @@
                check=True)
 
 shutil.rmtree(html_dir, ignore_errors=True)
-shutil.copytree(sphinx_build_dir / 'html', html_dir, doxygen_dir)
+shutil.copytree(sphinx_build_dir / 'html', html_dir)
 
 subprocess.run(['gi-docgen',
                 'generate',

diff --git a/doc/meson.build b/doc/meson.build
@@ -14,9 +14,14 @@
 
 subdir('glib')
 
+doxyfile_conf = configuration_data()
+doxyfile_conf.set('DATAFUSION_H', datafusion_h.full_path())
+doxyfile = configure_file(input: 'Doxyfile.in',
+                          output: 'Doxyfile',
+                          configuration: doxyfile_conf)
+
 depend_files = files(
   '..' / 'cbindgen.toml',
-  'Doxyfile',
   'source' / 'conf.py',
   'source' / 'example' / 'sql.rst',
   'source' / 'glib-api.rst',
@@ -27,7 +32,10 @@ depend_files = files(
   'source' / 'news.rst',
   'source' / 'raw-c-api.rst',
 )
-depend_files += [gi_docgen_toml]
+depend_files += [
+  doxyfile,
+  gi_docgen_toml,
+]
 
 custom_target('html',
               command: [

diff --git a/doc/source/developer/release.rst b/doc/source/developer/release.rst
@@ -61,7 +61,7 @@ APT/Yum repositories at https://apache.jfrog.io/artifactory/arrow/ are
 for Apache Arrow. We just reuse these APT/Yum repositories. So we must
 follow policy of https://apache.jfrog.io/artifactory/arrow/ .
 
-.. see-also::
+.. seealso::
 
    `Release Management Guide for Apache Arrow <apache-arrow-release_>`__.