diff options
author | David Robillard <d@drobilla.net> | 2022-06-27 12:59:34 -0400 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2022-07-10 13:39:53 -0400 |
commit | 5e78edf6e09373938a796cf44fb38d2309d04b4d (patch) | |
tree | e80618e5e092dcb3d9501a2568cf67489fe3d1bd /doc/c | |
parent | bcc1c936b15782d8fa59e2ebf471cf686527135c (diff) | |
download | serd-5e78edf6e09373938a796cf44fb38d2309d04b4d.tar.gz serd-5e78edf6e09373938a796cf44fb38d2309d04b4d.tar.bz2 serd-5e78edf6e09373938a796cf44fb38d2309d04b4d.zip |
Switch to meson build system
Diffstat (limited to 'doc/c')
-rw-r--r-- | doc/c/Doxyfile.in (renamed from doc/c/Doxyfile) | 9 | ||||
-rw-r--r-- | doc/c/api/meson.build | 6 | ||||
-rw-r--r-- | doc/c/meson.build | 52 | ||||
-rw-r--r-- | doc/c/wscript | 41 | ||||
-rw-r--r-- | doc/c/xml/meson.build | 18 |
5 files changed, 82 insertions, 44 deletions
diff --git a/doc/c/Doxyfile b/doc/c/Doxyfile.in index 600e0e94..12d0440b 100644 --- a/doc/c/Doxyfile +++ b/doc/c/Doxyfile.in @@ -2,12 +2,13 @@ PROJECT_NAME = Serd PROJECT_BRIEF = "A lightweight C library for working with RDF data" QUIET = YES -WARN_AS_ERROR = NO +WARN_AS_ERROR = YES WARN_IF_UNDOCUMENTED = NO WARN_NO_PARAMDOC = NO JAVADOC_AUTOBRIEF = YES +FULL_PATH_NAMES = NO CASE_SENSE_NAMES = YES HIDE_IN_BODY_DOCS = YES REFERENCES_LINK_SOURCE = NO @@ -28,6 +29,8 @@ PREDEFINED = SERD_ALLOCATED \ SERD_NULLABLE= \ SERD_PURE_FUNC= -INPUT = ../../include/serd/serd.h +RECURSIVE = YES +STRIP_FROM_PATH = @SERD_SRCDIR@ +INPUT = @SERD_SRCDIR@/include -OUTPUT_DIRECTORY = . +OUTPUT_DIRECTORY = @DOX_OUTPUT@ diff --git a/doc/c/api/meson.build b/doc/c/api/meson.build new file mode 100644 index 00000000..bc75345a --- /dev/null +++ b/doc/c/api/meson.build @@ -0,0 +1,6 @@ +c_serd_rst = custom_target( + 'serd.rst', + command: [dox_to_sphinx, '-f', '@INPUT0@', '@OUTDIR@'], + input: [c_index_xml] + c_rst_files, + output: 'serd.rst', +) diff --git a/doc/c/meson.build b/doc/c/meson.build new file mode 100644 index 00000000..ee104b13 --- /dev/null +++ b/doc/c/meson.build @@ -0,0 +1,52 @@ +config = configuration_data() +config.set('SERD_VERSION', meson.project_version()) +config.set('SERD_SRCDIR', serd_src_root) +config.set('SERD_TITLE', get_option('title')) + +conf_py = configure_file( + configuration: config, + input: files('../conf.py.in'), + output: 'conf.py', +) + +configure_file( + copy: true, + input: files('../summary.rst'), + output: 'summary.rst', +) + +c_rst_files = files( + 'index.rst', + 'overview.rst', +) + +foreach f : c_rst_files + configure_file(copy: true, input: f, output: '@PLAINNAME@') +endforeach + +subdir('xml') +subdir('api') + +# TODO: Add install_tag: 'doc' after requiring meson 0.60.0 + +custom_target( + 'singlehtml', + build_by_default: true, + command: [sphinx_build, '-M', 'singlehtml', '@OUTDIR@', '@OUTDIR@', + '-E', '-q', '-t', 'singlehtml'], + input: [c_rst_files, c_serd_rst, c_index_xml], + install: true, + install_dir: docdir / versioned_name, + output: 'singlehtml', +) + +custom_target( + 'html', + build_by_default: true, + command: [sphinx_build, '-M', 'html', '@OUTDIR@', '@OUTDIR@', + '-E', '-q', '-t', 'html'], + input: [c_rst_files, c_serd_rst, c_index_xml], + install: true, + install_dir: docdir / versioned_name, + output: 'html', +) diff --git a/doc/c/wscript b/doc/c/wscript deleted file mode 100644 index 9a524e3a..00000000 --- a/doc/c/wscript +++ /dev/null @@ -1,41 +0,0 @@ -#!/usr/bin/env python - -def build(bld): - dox_to_sphinx = bld.path.find_node("../../scripts/dox_to_sphinx.py") - index_xml = bld.path.get_bld().make_node("xml/index.xml") - - files = [ - ("../../resources/serd.svg", "sphinx/_static/serd.svg"), - ("../summary.rst", "sphinx/summary.rst"), - ("index.rst", "sphinx/index.rst"), - ("overview.rst", "sphinx/overview.rst"), - ] - - # Run Doxygen to generate XML documentation - bld(features="doxygen", doxyfile="Doxyfile") - - # Substitute variables to make Sphinx configuration file - bld(features="subst", - source="../conf.py.in", - target="sphinx/conf.py", - SERD_VERSION=bld.env.SERD_VERSION) - - # Copy static documentation files to Sphinx build directory - for f in files: - bld(features="subst", is_copy=True, source=f[0], target=f[1]) - - # Generate Sphinx markup from Doxygen XML - bld.add_group() - bld(rule="${PYTHON} " + dox_to_sphinx.abspath() + " -f ${SRC} ${TGT}", - source=index_xml, - target="sphinx/api/") - - doc_dir = bld.env.DOCDIR + "/serd-%s/" % bld.env.SERD_MAJOR_VERSION - - # Run Sphinx to generate HTML documentation - for builder in ["html", "singlehtml"]: - bld(features="sphinx", - sphinx_source=bld.path.get_bld().make_node("sphinx"), - sphinx_output_format=builder, - sphinx_options=["-E", "-q", "-t", builder], - install_path=doc_dir + "c/%s/" % builder) diff --git a/doc/c/xml/meson.build b/doc/c/xml/meson.build new file mode 100644 index 00000000..a49e2754 --- /dev/null +++ b/doc/c/xml/meson.build @@ -0,0 +1,18 @@ +doxygen = find_program('doxygen') + +config = configuration_data() +config.set('SERD_SRCDIR', serd_src_root) +config.set('DOX_OUTPUT', meson.current_build_dir() / '..') + +c_doxyfile = configure_file( + configuration: config, + input: files('../Doxyfile.in'), + output: 'Doxyfile', +) + +c_index_xml = custom_target( + 'index.xml', + command: [doxygen, '@INPUT0@'], + input: [c_doxyfile] + c_headers, + output: 'index.xml', +) |