aboutsummaryrefslogtreecommitdiffstats
path: root/doc/c
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2023-05-11 22:43:02 -0400
committerDavid Robillard <d@drobilla.net>2023-05-11 23:12:04 -0400
commit60cbe5b9b6d42bd850c5ea39c06b6e182f9c2645 (patch)
treed10b1910875079f5724ff92b68d711a7e9a6804b /doc/c
parent86894351ffb6cc7f9fd9a4d63ba0a6eecc64d29d (diff)
downloadserd-60cbe5b9b6d42bd850c5ea39c06b6e182f9c2645.tar.gz
serd-60cbe5b9b6d42bd850c5ea39c06b6e182f9c2645.tar.bz2
serd-60cbe5b9b6d42bd850c5ea39c06b6e182f9c2645.zip
Clean up documentation and remove junk files from install
Diffstat (limited to 'doc/c')
-rw-r--r--doc/c/Doxyfile.in39
-rw-r--r--doc/c/api/meson.build9
-rw-r--r--doc/c/index.rst14
-rw-r--r--doc/c/meson.build88
-rw-r--r--doc/c/overview.rst26
-rw-r--r--doc/c/xml/meson.build21
6 files changed, 0 insertions, 197 deletions
diff --git a/doc/c/Doxyfile.in b/doc/c/Doxyfile.in
deleted file mode 100644
index a33ec7c4..00000000
--- a/doc/c/Doxyfile.in
+++ /dev/null
@@ -1,39 +0,0 @@
-# Copyright 2021-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-PROJECT_NAME = Serd
-PROJECT_BRIEF = "A lightweight C library for working with RDF data"
-
-QUIET = YES
-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
-
-GENERATE_HTML = NO
-GENERATE_LATEX = NO
-GENERATE_XML = YES
-XML_PROGRAMLISTING = NO
-SHOW_FILES = NO
-
-MACRO_EXPANSION = YES
-PREDEFINED = SERD_ALLOCATED \
- SERD_API \
- SERD_CONST_FUNC= \
- SERD_DEPRECATED_BY(x)= \
- SERD_DISABLE_DEPRECATED \
- SERD_NONNULL= \
- SERD_NULLABLE= \
- SERD_PURE_FUNC=
-
-RECURSIVE = YES
-STRIP_FROM_PATH = @SERD_SRCDIR@
-INPUT = @SERD_SRCDIR@/include
-
-OUTPUT_DIRECTORY = @DOX_OUTPUT@
diff --git a/doc/c/api/meson.build b/doc/c/api/meson.build
deleted file mode 100644
index b40af2f1..00000000
--- a/doc/c/api/meson.build
+++ /dev/null
@@ -1,9 +0,0 @@
-# Copyright 2020-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-c_serd_rst = custom_target(
- 'serd.rst',
- command: [sphinxygen, '-f', '@INPUT0@', '@OUTDIR@'],
- input: [c_index_xml] + c_rst_files,
- output: 'serd.rst',
-)
diff --git a/doc/c/index.rst b/doc/c/index.rst
deleted file mode 100644
index 451b5d85..00000000
--- a/doc/c/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-..
- Copyright 2020-2021 David Robillard <d@drobilla.net>
- SPDX-License-Identifier: ISC
-
-####
-Serd
-####
-
-.. include:: summary.rst
-
-.. toctree::
-
- overview
- api/serd
diff --git a/doc/c/meson.build b/doc/c/meson.build
deleted file mode 100644
index f81a692a..00000000
--- a/doc/c/meson.build
+++ /dev/null
@@ -1,88 +0,0 @@
-# Copyright 2020-2023 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-# Check for Sphinx LV2 theme
-
-pymod = import('python')
-sphinx_lv2_theme_python = pymod.find_installation(
- modules: ['sphinx_lv2_theme'],
- required: false
-)
-
-if not sphinx_lv2_theme_python.found()
- warning('Missing sphinx_lv2_theme module, falling back to alabaster')
-endif
-
-# Generate Sphinx configuration file
-
-conf_config = configuration_data()
-conf_config.set('SERD_SRCDIR', serd_src_root)
-conf_config.set('SERD_TITLE', get_option('title'))
-conf_config.set('SERD_VERSION', meson.project_version())
-
-conf_py = configure_file(
- configuration: conf_config,
- input: files('../conf.py.in'),
- output: 'conf.py',
-)
-
-# Copy hand-written documentation sources
-
-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
-
-# Generate reference documentation sources
-
-subdir('xml')
-subdir('api')
-
-# Generate documentation with sphinx
-
-sphinx_flags = ['-E', '-a', '-q']
-if get_option('werror')
- sphinx_flags += ['-W']
-endif
-
-# TODO: Add install_tag: 'doc' after requiring meson 0.60.0
-
-if not get_option('singlehtml').disabled()
- custom_target(
- 'singlehtml',
- build_by_default: true,
- command: [
- sphinx_build,
- '-M', 'singlehtml', '@OUTDIR@', '@OUTDIR@', '-t', 'singlehtml',
- ] + sphinx_flags,
- input: [c_rst_files, c_serd_rst, c_index_xml, conf_py],
- install: true,
- install_dir: docdir / versioned_name,
- output: 'singlehtml',
- )
-endif
-
-if not get_option('html').disabled()
- custom_target(
- 'html',
- build_by_default: true,
- command: [
- sphinx_build,
- '-M', 'html', '@OUTDIR@', '@OUTDIR@', '-t', 'html',
- ] + sphinx_flags,
- input: [c_rst_files, c_serd_rst, c_index_xml, conf_py],
- install: true,
- install_dir: docdir / versioned_name,
- output: 'html',
- )
-endif
diff --git a/doc/c/overview.rst b/doc/c/overview.rst
deleted file mode 100644
index b03615b9..00000000
--- a/doc/c/overview.rst
+++ /dev/null
@@ -1,26 +0,0 @@
-..
- Copyright 2020-2021 David Robillard <d@drobilla.net>
- SPDX-License-Identifier: ISC
-
-########
-Overview
-########
-
-.. default-domain:: c
-.. highlight:: c
-
-The API revolves around two main types: the :doc:`api/serd_reader`,
-which reads text and fires callbacks,
-and the :doc:`api/serd_writer`,
-which writes text when driven by corresponding functions.
-Both work in a streaming fashion but still support pretty-printing,
-so the pair can be used to pretty-print, translate,
-or otherwise process arbitrarily large documents very quickly.
-The context of a stream is tracked by the :doc:`api/serd_env`,
-which stores the current base URI and set of namespace prefixes.
-
-The complete API is declared in ``serd.h``:
-
-.. code-block:: c
-
- #include <serd/serd.h>
diff --git a/doc/c/xml/meson.build b/doc/c/xml/meson.build
deleted file mode 100644
index 34852719..00000000
--- a/doc/c/xml/meson.build
+++ /dev/null
@@ -1,21 +0,0 @@
-# Copyright 2020-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-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',
-)