summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/c/Doxyfile.in (renamed from doc/c/Doxyfile)6
-rw-r--r--doc/c/api/meson.build6
-rw-r--r--doc/c/index.rst9
-rw-r--r--doc/c/meson.build48
-rw-r--r--doc/c/wscript39
-rw-r--r--doc/c/xml/meson.build18
-rw-r--r--doc/conf.py.in2
-rw-r--r--doc/meson.build15
-rw-r--r--doc/summary.rst (renamed from doc/sratom.rst)4
9 files changed, 99 insertions, 48 deletions
diff --git a/doc/c/Doxyfile b/doc/c/Doxyfile.in
index 3252d98..9180f1f 100644
--- a/doc/c/Doxyfile
+++ b/doc/c/Doxyfile.in
@@ -21,6 +21,8 @@ SHOW_FILES = NO
MACRO_EXPANSION = YES
PREDEFINED = SRATOM_API
-INPUT = ../../include/sratom/sratom.h
+RECURSIVE = YES
+STRIP_FROM_PATH = @SRATOM_SRCDIR@
+INPUT = @SRATOM_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 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/summary.rst
index bf37c17..94279ce 100644
--- a/doc/sratom.rst
+++ b/doc/summary.rst
@@ -1,7 +1,3 @@
-######
-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.