summaryrefslogtreecommitdiffstats
path: root/doc/c
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2023-09-02 19:00:54 -0400
committerDavid Robillard <d@drobilla.net>2023-09-21 20:16:18 -0400
commit7c8682a1b53713b3263034bc8db3cdb5839968b5 (patch)
treeef495ddf29b53786b57a925bec0a143a0431781b /doc/c
parent1d48d40ac4948b1864ca09e9d0a26fdd71bbee8d (diff)
downloadsratom-7c8682a1b53713b3263034bc8db3cdb5839968b5.tar.gz
sratom-7c8682a1b53713b3263034bc8db3cdb5839968b5.tar.bz2
sratom-7c8682a1b53713b3263034bc8db3cdb5839968b5.zip
Clean up documentation and remove junk files from install
Diffstat (limited to 'doc/c')
-rw-r--r--doc/c/Doxyfile.in31
-rw-r--r--doc/c/api/meson.build9
-rw-r--r--doc/c/index.rst14
-rw-r--r--doc/c/meson.build53
-rw-r--r--doc/c/overview.rst16
-rw-r--r--doc/c/reference.rst15
-rw-r--r--doc/c/xml/meson.build21
7 files changed, 0 insertions, 159 deletions
diff --git a/doc/c/Doxyfile.in b/doc/c/Doxyfile.in
deleted file mode 100644
index 5364912..0000000
--- a/doc/c/Doxyfile.in
+++ /dev/null
@@ -1,31 +0,0 @@
-# Copyright 2021-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-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
deleted file mode 100644
index 22aa355..0000000
--- a/doc/c/api/meson.build
+++ /dev/null
@@ -1,9 +0,0 @@
-# Copyright 2021-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-c_sratom_rst = custom_target(
- 'sratom.rst',
- command: [sphinxygen, '-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
deleted file mode 100644
index 4c7e619..0000000
--- a/doc/c/index.rst
+++ /dev/null
@@ -1,14 +0,0 @@
-..
- Copyright 2020-2021 David Robillard <d@drobilla.net>
- SPDX-License-Identifier: ISC
-
-######
-Sratom
-######
-
-.. include:: summary.rst
-
-.. toctree::
-
- overview
- api/sratom
diff --git a/doc/c/meson.build b/doc/c/meson.build
deleted file mode 100644
index 502dd83..0000000
--- a/doc/c/meson.build
+++ /dev/null
@@ -1,53 +0,0 @@
-# Copyright 2021-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-config = configuration_data()
-config.set('SRATOM_VERSION', meson.project_version())
-
-conf_py = configure_file(
- configuration: config,
- input: files('../conf.py.in'),
- output: 'conf.py',
-)
-
-summary_rst = configure_file(
- copy: true,
- input: files('../summary.rst'),
- output: 'summary.rst',
-)
-
-c_rst_files = files(
- 'index.rst',
- 'overview.rst',
-)
-
-sratom_doc_rst_files = [summary_rst] + c_rst_files
-
-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/overview.rst b/doc/c/overview.rst
deleted file mode 100644
index 4884839..0000000
--- a/doc/c/overview.rst
+++ /dev/null
@@ -1,16 +0,0 @@
-..
- Copyright 2020-2021 David Robillard <d@drobilla.net>
- SPDX-License-Identifier: ISC
-
-########
-Overview
-########
-
-.. default-domain:: c
-.. highlight:: c
-
-The complete API is declared in ``sratom.h``:
-
-.. code-block:: c
-
- #include <sratom/sratom.h>
diff --git a/doc/c/reference.rst b/doc/c/reference.rst
deleted file mode 100644
index 5deb127..0000000
--- a/doc/c/reference.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-..
- Copyright 2020-2021 David Robillard <d@drobilla.net>
- SPDX-License-Identifier: ISC
-
-#############
-API Reference
-#############
-
-This section contains the generated documentation for all symbols in the public
-API.
-
-.. toctree::
-
- api/sratom
-
diff --git a/doc/c/xml/meson.build b/doc/c/xml/meson.build
deleted file mode 100644
index cf1b148..0000000
--- a/doc/c/xml/meson.build
+++ /dev/null
@@ -1,21 +0,0 @@
-# Copyright 2021-2022 David Robillard <d@drobilla.net>
-# SPDX-License-Identifier: 0BSD OR ISC
-
-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',
-)