From 75e647def0f67647ec7ba1405e26d809a87c62fc Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sun, 3 Jul 2022 20:47:34 -0400 Subject: Switch to meson build system --- doc/c/Doxyfile | 26 -------------------------- doc/c/Doxyfile.in | 28 ++++++++++++++++++++++++++++ doc/c/api/meson.build | 6 ++++++ doc/c/index.rst | 9 +++++++-- doc/c/meson.build | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ doc/c/wscript | 39 --------------------------------------- doc/c/xml/meson.build | 18 ++++++++++++++++++ doc/conf.py.in | 2 +- doc/meson.build | 15 +++++++++++++++ doc/sratom.rst | 9 --------- doc/summary.rst | 5 +++++ 11 files changed, 128 insertions(+), 77 deletions(-) delete mode 100644 doc/c/Doxyfile create mode 100644 doc/c/Doxyfile.in create mode 100644 doc/c/api/meson.build create mode 100644 doc/c/meson.build delete mode 100644 doc/c/wscript create mode 100644 doc/c/xml/meson.build create mode 100644 doc/meson.build delete mode 100644 doc/sratom.rst create mode 100644 doc/summary.rst (limited to 'doc') diff --git a/doc/c/Doxyfile b/doc/c/Doxyfile deleted file mode 100644 index 3252d98..0000000 --- a/doc/c/Doxyfile +++ /dev/null @@ -1,26 +0,0 @@ -PROJECT_NAME = Sratom -PROJECT_BRIEF = "A small library for serializing LV2 atoms" - -QUIET = YES -WARN_AS_ERROR = NO -WARN_IF_UNDOCUMENTED = NO -WARN_NO_PARAMDOC = NO - -JAVADOC_AUTOBRIEF = YES - -CASE_SENSE_NAMES = YES -HIDE_IN_BODY_DOCS = YES -REFERENCES_LINK_SOURCE = NO - -GENERATE_HTML = NO -GENERATE_LATEX = NO -GENERATE_XML = YES -XML_PROGRAMLISTING = NO -SHOW_FILES = NO - -MACRO_EXPANSION = YES -PREDEFINED = SRATOM_API - -INPUT = ../../include/sratom/sratom.h - -OUTPUT_DIRECTORY = . diff --git a/doc/c/Doxyfile.in b/doc/c/Doxyfile.in new file mode 100644 index 0000000..9180f1f --- /dev/null +++ b/doc/c/Doxyfile.in @@ -0,0 +1,28 @@ +PROJECT_NAME = Sratom +PROJECT_BRIEF = "A small library for serializing LV2 atoms" + +QUIET = YES +WARN_AS_ERROR = NO +WARN_IF_UNDOCUMENTED = NO +WARN_NO_PARAMDOC = NO + +JAVADOC_AUTOBRIEF = YES + +CASE_SENSE_NAMES = YES +HIDE_IN_BODY_DOCS = YES +REFERENCES_LINK_SOURCE = NO + +GENERATE_HTML = NO +GENERATE_LATEX = NO +GENERATE_XML = YES +XML_PROGRAMLISTING = NO +SHOW_FILES = NO + +MACRO_EXPANSION = YES +PREDEFINED = SRATOM_API + +RECURSIVE = YES +STRIP_FROM_PATH = @SRATOM_SRCDIR@ +INPUT = @SRATOM_SRCDIR@/include + +OUTPUT_DIRECTORY = @DOX_OUTPUT@ diff --git a/doc/c/api/meson.build b/doc/c/api/meson.build new file mode 100644 index 0000000..0ece07c --- /dev/null +++ b/doc/c/api/meson.build @@ -0,0 +1,6 @@ +c_sratom_rst = custom_target( + 'sratom.rst', + command: [dox_to_sphinx, '-f', '@INPUT0@', '@OUTDIR@'], + input: [c_index_xml] + c_rst_files, + output: 'sratom.rst', +) diff --git a/doc/c/index.rst b/doc/c/index.rst index b51db16..2e02d5d 100644 --- a/doc/c/index.rst +++ b/doc/c/index.rst @@ -1,5 +1,10 @@ +###### +Sratom +###### + +.. include:: summary.rst + .. toctree:: - sratom overview - reference + api/sratom diff --git a/doc/c/meson.build b/doc/c/meson.build new file mode 100644 index 0000000..8ed81c0 --- /dev/null +++ b/doc/c/meson.build @@ -0,0 +1,48 @@ +config = configuration_data() +config.set('SRATOM_VERSION', meson.project_version()) + +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') + +docs = custom_target( + 'singlehtml', + build_by_default: true, + command: [sphinx_build, '-M', 'singlehtml', '@OUTDIR@', '@OUTDIR@', + '-E', '-q', '-t', 'singlehtml'], + input: [c_rst_files, c_sratom_rst, c_index_xml], + install: true, + install_dir: docdir / 'sratom-0', + output: 'singlehtml', +) + +docs = custom_target( + 'html', + build_by_default: true, + command: [sphinx_build, '-M', 'html', '@OUTDIR@', '@OUTDIR@', + '-E', '-q', '-t', 'html'], + input: [c_rst_files, c_sratom_rst, c_index_xml], + install: true, + install_dir: docdir / 'sratom-0', + output: 'html', +) diff --git a/doc/c/wscript b/doc/c/wscript deleted file mode 100644 index 9ea3094..0000000 --- a/doc/c/wscript +++ /dev/null @@ -1,39 +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 = [ - ("../sratom.rst", "sphinx/sratom.rst"), - ("index.rst", "sphinx/index.rst"), - ("overview.rst", "sphinx/overview.rst"), - ("reference.rst", "sphinx/reference.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/") - - # Run Sphinx to generate HTML documentation - doc_dir = bld.env.DOCDIR + "/sratom-%s/" % bld.env.SRATOM_MAJOR_VERSION - bld(features="sphinx", - sphinx_source=bld.path.get_bld().make_node("sphinx"), - sphinx_output_format="singlehtml", - sphinx_options=["-E", "-q", "-t", "singlehtml"], - install_path=doc_dir + "c/singlehtml/") diff --git a/doc/c/xml/meson.build b/doc/c/xml/meson.build new file mode 100644 index 0000000..eaa6bcc --- /dev/null +++ b/doc/c/xml/meson.build @@ -0,0 +1,18 @@ +doxygen = find_program('doxygen') + +config = configuration_data() +config.set('SRATOM_SRCDIR', sratom_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', +) diff --git a/doc/conf.py.in b/doc/conf.py.in index 0e8b53f..f3aee92 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -35,9 +35,9 @@ nitpick_ignore = list(map(lambda x: ("c:identifier", x), _opaque)) # HTML output -html_theme = "sphinx_lv2_theme" html_copy_source = False html_short_title = "Sratom" +html_theme = "sphinx_lv2_theme" if tags.has("singlehtml"): html_sidebars = { diff --git a/doc/meson.build b/doc/meson.build new file mode 100644 index 0000000..46fc3bb --- /dev/null +++ b/doc/meson.build @@ -0,0 +1,15 @@ +docdir = get_option('datadir') / 'doc' + +doxygen = find_program('doxygen', required: get_option('docs')) +dox_to_sphinx = files('../scripts/dox_to_sphinx.py') +sphinx_build = find_program('sphinx-build', required: get_option('docs')) + +build_docs = doxygen.found() and sphinx_build.found() + +if build_docs + subdir('c') +endif + +if not meson.is_subproject() + summary('Documentation', build_docs, bool_yn: true) +endif diff --git a/doc/sratom.rst b/doc/sratom.rst deleted file mode 100644 index bf37c17..0000000 --- a/doc/sratom.rst +++ /dev/null @@ -1,9 +0,0 @@ -###### -Sratom -###### - -Sratom is a small library for serializing `LV2 atoms`_. Sratom reads/writes -atoms from/to RDF, allowing them to be converted between binary and text or -stored in a model. - -.. _LV2 atoms: http://lv2plug.in/ns/ext/atom diff --git a/doc/summary.rst b/doc/summary.rst new file mode 100644 index 0000000..94279ce --- /dev/null +++ b/doc/summary.rst @@ -0,0 +1,5 @@ +Sratom is a small library for serializing `LV2 atoms`_. Sratom reads/writes +atoms from/to RDF, allowing them to be converted between binary and text or +stored in a model. + +.. _LV2 atoms: http://lv2plug.in/ns/ext/atom -- cgit v1.2.1