summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorChristian Persch <chpe@src.gnome.org>2022-05-03 21:57:58 +0200
committerChristian Persch <chpe@src.gnome.org>2022-05-03 22:03:56 +0200
commit0f7a2ff5b87a40b28f3c340a40ed9ff7ecad459b (patch)
tree47fdaccf368e4c6b358d4466c39adb85c26c9910 /doc
parent5147453115f46d2dc91b797cd12f2ede220ea100 (diff)
downloadvte-0f7a2ff5b87a40b28f3c340a40ed9ff7ecad459b.tar.gz
docs: Port to gi-docgen
This greatly simplifies building the documentation for both vte/gtk3 and vte/gtk4.
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/Makefile.docs520
-rw-r--r--doc/reference/gtk3/meson.build55
-rw-r--r--doc/reference/gtk4/meson.build55
-rw-r--r--doc/reference/licence.md27
-rw-r--r--doc/reference/meson.build87
-rw-r--r--doc/reference/vte-docs.xml182
-rw-r--r--doc/reference/vte-overrides.txt.in0
-rw-r--r--doc/reference/vte-sections.txt.in281
-rw-r--r--doc/reference/vte.types.in17
9 files changed, 104 insertions, 1120 deletions
diff --git a/doc/reference/Makefile.docs b/doc/reference/Makefile.docs
deleted file mode 100644
index b18f0a41..00000000
--- a/doc/reference/Makefile.docs
+++ /dev/null
@@ -1,520 +0,0 @@
-# -*- mode: makefile -*-
-#
-# Copyright © 2020, 2021 Christian Persch
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-NULL =
-V ?= 0
-
-abs_srcdir ?= $(srcdir)
-abs_builddir ?= $(builddir)
-top_srcdir ?= $(abs_top_srcdir)
-top_builddir ?= $(abs_top_builddir)
-
-datadir ?= /usr/share
-
-CPP = cpp
-CPPFLAGS =
-
-GREP ?= grep
-GREPFLAGS =
-
-LN_S = ln -s
-
-PACKAGE ?= vte
-PACKAGE_BUGREPORT ?= https://gitlab.gnome.org/GNOME/vte/issues/
-PACKAGE_NAME ?= vte
-PACKAGE_STRING ?= vte
-PACKAGE_TARNAME ?= vte
-PACKAGE_URL ?= https://gitlab.gnome.org/GNOME/vte/
-PACKAGE_VERSION ?= $(VERSION)
-
-DOC_MODULE = vte-gtk$(VTE_GTK)
-
-DOC_MODULE_VERSION = $(VTE_API_VERSION)
-
-DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
-
-DOC_SOURCE_DIR = \
- $(top_srcdir)/src \
- $(top_srcdir)/src/vte \
- $(top_builddir)/src \
- $(top_builddir)/src/vte \
- $(NULL)
-
-SCANGOBJ_OPTIONS =
-
-SCAN_OPTIONS = \
- --deprecated-guards="VTE_DISABLE_DEPRECATED" \
- --ignore-decorators='_VTE_GNUC_NONNULL()|_VTE_PUBLIC|_VTE_DEPRECATED|_VTE_CXX_NOEXCEPT' \
- $(NULL)
-
-MKDB_OPTIONS = \
- --source-suffixes=c,cc,h,hh \
- --xml-mode \
- --output-format=xml \
- --name-space=vte \
- $(NULL)
-
-MKTMPL_OPTIONS =
-
-MKHTML_OPTIONS = \
- --path="$(abs_builddir)" \
- $(NULL)
-
-MKPDF_OPTIONS = \
- --path="$(abs_builddir)" \
- $(NULL)
-
-FIXXREF_OPTIONS = \
- --extra-dir=$(CAIRO_PREFIX)/share/gtk-doc/html/cairo \
- --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/glib \
- --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gobject \
- --extra-dir=$(GLIB_PREFIX)/share/gtk-doc/html/gio \
- --extra-dir=$(PANGO_PREFIX)/share/gtk-doc/html/pango \
- $(NULL)
-
-ifeq ($(VTE_GTK),3)
-FIXXREF_OPTIONS += \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk3 \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk3 \
- $(NULL)
-endif
-
-ifeq ($(VTE_GTK),4)
-FIXXREF_OPTIONS += \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/graphene \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gdk4 \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gsk4 \
- --extra-dir=$(GTK_PREFIX)/share/gtk-doc/html/gtk4 \
- $(NULL)
-endif
-
-HFILE_GLOB = \
- $(top_builddir)/src/vte/*.h \
- $(top_srcdir)/src/vte/*.h \
- $(NULL)
-
-CFILE_GLOB = \
- $(top_builddir)/src/*.c \
- $(top_srcdir)/src/*.c \
- $(top_srcdir)/src/*.cc \
- $(NULL)
-
-EXTRA_HFILES =
-
-IGNORE_HFILES = \
- box_drawing.h \
- buffer.h \
- caps.hh \
- cell.hh \
- config.h \
- debug.h \
- keymap.h \
- marshal.h \
- modes.hh \
- modes-ecma.hh \
- modes-private.hh \
- parser.hh \
- parser-arg.hh \
- parser-c01.hh \
- parser-charset.hh \
- parser-charset-tables.hh \
- parser-cmd.hh \
- parser-csi.hh \
- parser-dcs.hh \
- parser-esc.hh \
- parser-glue.hh \
- parser-osc.hh \
- parser-reply.hh \
- parser-string.hh \
- ring.hh \
- tabstops.hh \
- vteaccess.h \
- vteconv.h \
- vtedraw.h \
- vteinternal.hh \
- vterowdata.hh \
- vtestream-base.h \
- vtestream-file.h \
- vtestream.h \
- vtetypebuiltins.h \
- vteunistr.h \
- $(NULL)
-
-HTML_IMAGES =
-
-content_files =
-
-expand_content_files =
-
-GTKDOC_CFLAGS = \
- -DVTE_COMPILATION \
- $(shell pkg-config --cflags --libs glib-2.0 gobject-2.0) \
- $(NULL)
-
-VTE_LIB_PATH = $(shell dirname $(VTE_LIB))
-
-ifeq ($(VTE_GTK),3)
-VTE_LIB_NAME = vte-$(VTE_API_VERSION)
-endif
-ifeq ($(VTE_GTK),4)
-VTE_LIB_NAME = vte-$(VTE_API_VERSION)-gtk4
-endif
-
-GTKDOC_LIBS = \
- -L$(VTE_LIB_PATH) -l$(VTE_LIB_NAME) \
- $(shell pkg-config --libs --libs glib-2.0 gobject-2.0) \
- $(NULL)
-
-# Rules for building gtk3/4 versions of the gtk-doc inputs
-
-AM_V_at = $(AM_V_at_$(V))
-AM_V_at_0 = @
-AM_V_at_1 =
-
-AM_V_GEN = $(AM_V_GEN_$(V))
-AM_V_GEN_0 = @echo " GEN " $@;
-AM_V_GEN_1 =
-
-vte-gtk$(VTE_GTK)-sections.txt: $(srcdir)/../vte-sections.txt.in
- $(AM_V_GEN)$(CPP) -E $(CPPFLAGS) -DVTE_GTK=$(VTE_GTK) $< | $(GREP) $(GREPFLAGS) -Ev '^\s*#|^$$' > $@
-
-vte-gtk$(VTE_GTK)-overrides.txt: $(srcdir)/../vte-overrides.txt.in
- $(AM_V_GEN)$(CPP) -E $(CPPFLAGS) -DVTE_GTK=$(VTE_GTK) $< | $(GREP) $(GREPFLAGS) -Ev '^\s*#|^$$' > $@ || true
-
-vte-gtk$(VTE_GTK).types: $(srcdir)/../vte.types.in
- $(AM_V_GEN)$(CPP) -E -fpreprocessed $(CPPFLAGS) -DVTE_GTK=$(VTE_GTK) $< | $(GREP) $(GREPFLAGS) -Ev '^\s*#|^$$' > $@
-
-$(DOC_MAIN_SGML_FILE): $(srcdir)/../vte-docs.xml
- $(AM_V_GEN)cp -f $< $@
-
-# The following is copied from gtk-doc, and adapted to work with
-# plain make instead of requiring automake.
-#
-# Copyright (C) 2003 James Henstridge
-# 2004-2007 Damon Chaplin
-# 2007-2017 Stefan Sauer
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <https://www.gnu.org/licenses/>.
-
-####################################
-# Everything below here is generic #
-####################################
-
-CC ?= cc
-CFLAGS ?=
-
-INSTALL = install -c
-INSTALL_DATA = $(INSTALL) -m 644
-
-GTKDOC_CC = $(CC) $(INCLUDES) $(GTKDOC_DEPS_CFLAGS) $(CPPFLAGS) $(CFLAGS)
-GTKDOC_LD = $(CC) $(GTKDOC_DEPS_LIBS) $(CFLAGS) $(LDFLAGS)
-GTKDOC_RUN =
-
-GTKDOC_CHECK_PATH = gtkdoc-check
-GTKDOC_REBASE = gtkdoc-rebase
-
-MKDIR_P ?= mkdir -p
-
-# We set GPATH here; this gives us semantics for GNU make
-# which are more like other make's VPATH, when it comes to
-# whether a source that is a target of one rule is then
-# searched for in VPATH/GPATH.
-#
-GPATH = $(srcdir)
-
-HTML_DIR = $(datadir)/gtk-doc/html
-
-TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE)
-
-SETUP_FILES = \
- $(content_files) \
- $(expand_content_files) \
- $(DOC_MAIN_SGML_FILE) \
- $(DOC_MODULE)-sections.txt \
- $(DOC_MODULE)-overrides.txt
-
-SETUP_FILES_GENERATED = \
- $(DOC_MODULE)-sections.txt \
- $(DOC_MODULE)-overrides.txt \
- $(DOC_MODULE).types \
- $(DOC_MAIN_SGML_FILE)
-
-EXTRA_DIST = \
- $(HTML_IMAGES) \
- $(SETUP_FILES)
-
-DOC_STAMPS=setup-build.stamp scan-build.stamp sgml-build.stamp \
- html-build.stamp pdf-build.stamp \
- sgml.stamp html.stamp pdf.stamp
-
-SCANOBJ_FILES = \
- $(DOC_MODULE).actions \
- $(DOC_MODULE).args \
- $(DOC_MODULE).hierarchy \
- $(DOC_MODULE).interfaces \
- $(DOC_MODULE).prerequisites \
- $(DOC_MODULE).signals
-
-REPORT_FILES = \
- $(DOC_MODULE)-undocumented.txt \
- $(DOC_MODULE)-undeclared.txt \
- $(DOC_MODULE)-unused.txt
-
-gtkdoc-check.test:
- $(AM_V_GEN)echo "#!/bin/sh -e" > $@; \
- echo "$(GTKDOC_CHECK_PATH) || exit 1" >> $@; \
- chmod +x $@
-
-CLEANFILES = $(SCANOBJ_FILES) $(REPORT_FILES) $(DOC_STAMPS) gtkdoc-check.test
-
-HTML_BUILD_STAMP=html-build.stamp
-#PDF_BUILD_STAMP=pdf-build.stamp
-PDF_BUILD_STAMP=
-
-all-gtk-doc: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
-.PHONY: all-gtk-doc
-
-all-local: all-gtk-doc
-
-docs: $(HTML_BUILD_STAMP) $(PDF_BUILD_STAMP)
-
-$(REPORT_FILES): sgml-build.stamp
-
-#### setup ####
-
-GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V))
-GTK_DOC_V_SETUP_0=@echo " DOC Preparing build";
-GTK_DOC_V_SETUP_1=
-
-setup-build.stamp: $(SETUP_FILES_GENERATED)
- -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
- files=`echo $(SETUP_FILES) $(DOC_MODULE).types`; \
- if test "x$$files" != "x" ; then \
- for file in $$files ; do \
- destdir=`dirname $(abs_builddir)/$$file`; \
- test -d "$$destdir" || $(MKDIR_P) "$$destdir"; \
- test -f $(abs_srcdir)/$$file && \
- cp -pf $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \
- done; \
- fi; \
- fi
- $(AM_V_at)touch setup-build.stamp
-
-#### scan ####
-
-GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V))
-GTK_DOC_V_SCAN_0=@echo " DOC Scanning header files";
-GTK_DOC_V_SCAN_1=
-
-GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V))
-GTK_DOC_V_INTROSPECT_0=@echo " DOC Introspecting gobjects";
-GTK_DOC_V_INTROSPECT_1=
-
-scan-build.stamp: setup-build.stamp $(HFILE_GLOB) $(CFILE_GLOB)
- $(GTK_DOC_V_SCAN)_source_dir='' ; \
- for i in $(DOC_SOURCE_DIR) ; do \
- _source_dir="$${_source_dir} --source-dir=$$i" ; \
- done ; \
- gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES)
- $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \
- scanobj_options=""; \
- gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \
- if test "$$?" = "0"; then \
- if test "x$(V)" = "x1"; then \
- scanobj_options="--verbose"; \
- fi; \
- fi; \
- CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" RUN="$(GTKDOC_RUN)" CFLAGS="$(GTKDOC_CFLAGS) $(CFLAGS)" LDFLAGS="$(GTKDOC_LIBS) $(LDFLAGS)" LD_LIBRARY_PATH="$(VTE_LIB_PATH)" \
- gtkdoc-scangobj $(SCANGOBJ_OPTIONS) $$scanobj_options --module=$(DOC_MODULE); \
- else \
- for i in $(SCANOBJ_FILES) ; do \
- test -f $$i || touch $$i ; \
- done \
- fi
- $(AM_V_at)touch scan-build.stamp
-
-$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): scan-build.stamp
- @true
-
-#### xml ####
-
-GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V))
-GTK_DOC_V_XML_0=@echo " DOC Building XML";
-GTK_DOC_V_XML_1=
-
-sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(HFILE_GLOB) $(CFILE_GLOB) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) xml/gtkdocentities.ent $(DOC_MAIN_SGML_FILE)
- $(GTK_DOC_V_XML)_source_dir='' ; \
- for i in $(DOC_SOURCE_DIR) ; do \
- _source_dir="$${_source_dir} --source-dir=$$i" ; \
- done ; \
- gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS)
- $(AM_V_at)touch sgml-build.stamp
-
-sgml.stamp: sgml-build.stamp
- @true
-
-xml/gtkdocentities.ent:
- $(GTK_DOC_V_XML)$(MKDIR_P) $(@D) && ( \
- echo "<!ENTITY package \"$(PACKAGE)\">"; \
- echo "<!ENTITY package_bugreport \"$(PACKAGE_BUGREPORT)\">"; \
- echo "<!ENTITY package_name \"$(PACKAGE_NAME)\">"; \
- echo "<!ENTITY package_string \"$(PACKAGE_STRING)\">"; \
- echo "<!ENTITY package_tarname \"$(PACKAGE_TARNAME)\">"; \
- echo "<!ENTITY package_url \"$(PACKAGE_URL)\">"; \
- echo "<!ENTITY package_version \"$(PACKAGE_VERSION)\">"; \
- ) > $@
-
-
-#### html ####
-
-GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V))
-GTK_DOC_V_HTML_0=@echo " DOC Building HTML";
-GTK_DOC_V_HTML_1=
-
-GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V))
-GTK_DOC_V_XREF_0=@echo " DOC Fixing cross-references";
-GTK_DOC_V_XREF_1=
-
-GTKDOC_MKHTML = gtkdoc-mkhtml
-
-html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
- $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \
- mkhtml_options=""; \
- $(GTKDOC_MKHTML) 2>&1 --help | grep >/dev/null "\-\-verbose"; \
- if test "$$?" = "0"; then \
- if test "x$(V)" = "x1"; then \
- mkhtml_options="$$mkhtml_options --verbose"; \
- fi; \
- fi; \
- $(GTKDOC_MKHTML) 2>&1 --help | grep >/dev/null "\-\-path"; \
- if test "$$?" = "0"; then \
- mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \
- fi; \
- cd html && $(GTKDOC_MKHTML) $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE)
- -@test "x$(HTML_IMAGES)" = "x" || \
- for file in $(HTML_IMAGES) ; do \
- test -f $(abs_srcdir)/$$file && cp $(abs_srcdir)/$$file $(abs_builddir)/html; \
- test -f $(abs_builddir)/$$file && cp $(abs_builddir)/$$file $(abs_builddir)/html; \
- test -f $$file && cp $$file $(abs_builddir)/html; \
- done;
- $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS)
- $(AM_V_at)touch html-build.stamp
-
-#### pdf ####
-
-GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V))
-GTK_DOC_V_PDF_0=@echo " DOC Building PDF";
-GTK_DOC_V_PDF_1=
-
-pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) $(expand_content_files)
- $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \
- mkpdf_options=""; \
- gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \
- if test "$$?" = "0"; then \
- if test "x$(V)" = "x1"; then \
- mkpdf_options="$$mkpdf_options --verbose"; \
- fi; \
- fi; \
- if test "x$(HTML_IMAGES)" != "x"; then \
- for img in $(HTML_IMAGES); do \
- part=`dirname $$img`; \
- echo $$mkpdf_options | grep >/dev/null "\-\-imgdir=$$part "; \
- if test $$? != 0; then \
- mkpdf_options="$$mkpdf_options --imgdir=$$part"; \
- fi; \
- done; \
- fi; \
- gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS)
- $(AM_V_at)touch pdf-build.stamp
-
-##############
-
-clean-local:
- @rm -f *~ *.bak
- @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-types" ; then \
- rm -f $(DOC_MODULE).types; \
- fi
- @if echo $(SCAN_OPTIONS) | grep -q "\-\-rebuild-sections" ; then \
- rm -f $(DOC_MODULE)-sections.txt; \
- fi
-
-distclean-local:
- @rm -rf xml html $(REPORT_FILES) $(DOC_MODULE).pdf \
- $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt
- @if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \
- rm -f $(SETUP_FILES) $(DOC_MODULE).types; \
- fi
-
-maintainer-clean-local:
- @rm -rf xml html
-
-install-data-local:
- @installfiles=`echo $(builddir)/html/*`; \
- if test "$$installfiles" = '$(builddir)/html/*'; \
- then echo 1>&2 'Nothing to install' ; \
- else \
- if test -n "$(DOC_MODULE_VERSION)"; then \
- installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
- else \
- installdir="$(DESTDIR)$(TARGET_DIR)"; \
- fi; \
- $(MKDIR_P) $${installdir} ; \
- for i in $$installfiles; do \
- echo ' $(INSTALL_DATA) '$$i ; \
- $(INSTALL_DATA) $$i $${installdir}; \
- done; \
- if test -n "$(DOC_MODULE_VERSION)"; then \
- mv -f $${installdir}/$(DOC_MODULE).devhelp2 \
- $${installdir}/$(DOC_MODULE)-$(DOC_MODULE_VERSION).devhelp2; \
- fi; \
- $(GTKDOC_REBASE) --relative --dest-dir=$(DESTDIR) --html-dir=$${installdir}; \
- fi
-
-uninstall-local:
- @if test -n "$(DOC_MODULE_VERSION)"; then \
- installdir="$(DESTDIR)$(TARGET_DIR)-$(DOC_MODULE_VERSION)"; \
- else \
- installdir="$(DESTDIR)$(TARGET_DIR)"; \
- fi; \
- rm -rf $${installdir}
-
-dist-check-gtkdoc: docs
-
-dist-hook: dist-check-gtkdoc all-gtk-doc dist-hook-local
- @$(MKDIR_P) $(distdir)/html
- @cp ./html/* $(distdir)/html
- @-cp ./$(DOC_MODULE).pdf $(distdir)/
- @-cp ./$(DOC_MODULE).types $(distdir)/
- @-cp ./$(DOC_MODULE)-sections.txt $(distdir)/
- @cd $(distdir) && rm -f $(DISTCLEANFILES)
- @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html
-
-.PHONY : dist-hook-local docs
-
-meson.stamp: docs
- @touch meson.stamp
diff --git a/doc/reference/gtk3/meson.build b/doc/reference/gtk3/meson.build
deleted file mode 100644
index f03b2580..00000000
--- a/doc/reference/gtk3/meson.build
+++ /dev/null
@@ -1,55 +0,0 @@
-# Copyright © 2020, 2021 Christian Persch
-#
-# This library is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this library. If not, see <https://www.gnu.org/licenses/>.
-
-make_args_gtk3 = [
- '-f', meson.current_source_dir() / '..' / 'Makefile.docs',
- '--directory', meson.current_build_dir(),
- 'srcdir=' + meson.current_source_dir(),
- 'builddir=' + meson.current_build_dir(),
- 'abs_top_srcdir=' + meson.source_root(),
- 'abs_top_builddir=' + meson.build_root(),
- 'datadir=' + vte_prefix / vte_datadir,
- 'CAIRO_PREFIX=' + cairo_dep.get_pkgconfig_variable('prefix'),
- 'GLIB_PREFIX=' + glib_dep.get_pkgconfig_variable('prefix'),
- 'GTK_PREFIX=' + gtk3_dep.get_pkgconfig_variable('prefix'),
- 'PANGO_PREFIX=' + pango_dep.get_pkgconfig_variable('prefix'),
- 'CC=' + ' '.join(cc.cmd_array()),
- 'VERSION=' + meson.project_version(),
- 'VTE_API_VERSION=' + vte_api_version,
- 'VTE_GTK=3',
- 'VTE_LIB=' + libvte_gtk3.full_path(),
-]
-
-stamp = custom_target(
- 'meson.stamp',
- build_by_default: true,
- capture: false,
- command: [make] + make_args_gtk3 + [
- 'meson.stamp',
- ],
- depends: [
- libvte_gtk3,
- ],
- install: false,
- output: 'meson.stamp',
-)
-
-meson.add_install_script(
- make,
- make_args_gtk3,
- 'install-data-local',
-)
-
-# Unfortunately, there's no way to hook up the 'clean-local' target
diff --git a/doc/reference/gtk4/meson.build b/doc/reference/gtk4/meson.build
deleted file mode 100644
index 7f42e86f..00000000
--- a/doc/reference/gtk4/meson.build
+++ /dev/null
@@ -1,55 +0,0 @@
-# Copyright © 2020, 2021 Christian Persch
-#
-# This library is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published
-# by the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This library is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU Lesser General Public License for more details.
-#
-# You should have received a copy of the GNU Lesser General Public License
-# along with this library. If not, see <https://www.gnu.org/licenses/>.
-
-make_args_gtk4 = [
- '-f', meson.current_source_dir() / '..' / 'Makefile.docs',
- '--directory', meson.current_build_dir(),
- 'srcdir=' + meson.current_source_dir(),
- 'builddir=' + meson.current_build_dir(),
- 'abs_top_srcdir=' + meson.source_root(),
- 'abs_top_builddir=' + meson.build_root(),
- 'datadir=' + vte_prefix / vte_datadir,
- 'CAIRO_PREFIX=' + cairo_dep.get_pkgconfig_variable('prefix'),
- 'GLIB_PREFIX=' + glib_dep.get_pkgconfig_variable('prefix'),
- 'GTK_PREFIX=' + gtk4_dep.get_pkgconfig_variable('prefix'),
- 'PANGO_PREFIX=' + pango_dep.get_pkgconfig_variable('prefix'),
- 'CC=' + ' '.join(cc.cmd_array()),
- 'VERSION=' + meson.project_version(),
- 'VTE_API_VERSION=' + vte_api_version,
- 'VTE_GTK=4',
- 'VTE_LIB=' + libvte_gtk4.full_path(),
-]
-
-stamp = custom_target(
- 'meson.stamp',
- build_by_default: true,
- capture: false,
- command: [make] + make_args_gtk4 + [
- 'meson.stamp',
- ],
- depends: [
- libvte_gtk4,
- ],
- install: false,
- output: 'meson.stamp',
-)
-
-meson.add_install_script(
- make,
- make_args_gtk4,
- 'install-data-local',
-)
-
-# Unfortunately, there's no way to hook up the 'clean-local' target
diff --git a/doc/reference/licence.md b/doc/reference/licence.md
new file mode 100644
index 00000000..6c0b1d9b
--- /dev/null
+++ b/doc/reference/licence.md
@@ -0,0 +1,27 @@
+# Copyright © 2022 Christian Persch
+#
+# This library is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this library. If not, see <https://www.gnu.org/licenses/>.
+
+This documentation is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This documentation is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this documentation. If not, see <https://www.gnu.org/licenses/>.
diff --git a/doc/reference/meson.build b/doc/reference/meson.build
index 793bed5d..3d98c7ae 100644
--- a/doc/reference/meson.build
+++ b/doc/reference/meson.build
@@ -1,4 +1,4 @@
-# Copyright © 2021 Christian Persch
+# Copyright © 2021, 2022 Christian Persch
#
# This library is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License as published
@@ -13,18 +13,85 @@
# You should have received a copy of the GNU Lesser General Public License
# along with this library. If not, see <https://www.gnu.org/licenses/>.
-# It turned out to be impossible to build gtk3 and gtk4 versions of the
-# docs from the same source using meson's gnome.gtkdoc(). Instead, build
-# using make with a gtk-doc.make-derived Makefile.
+assert(get_option('gir'), 'Introspection must be enabled to build docs')
-make = find_program('gmake', 'make')
+gidocgen = find_program('gi-docgen', required: true)
-cairo_dep = dependency('cairo')
+doc_conf = configuration_data()
+doc_conf.set('version', meson.project_version())
+
+doc_sources = [
+ 'licence.md',
+]
+
+docdir = vte_datadir / 'doc'
if get_option('gtk3')
- subdir('gtk3')
-endif
+
+ libvte_gtk3_docs_toml = configure_file(
+ configuration: doc_conf,
+ input: 'vte-gtk3.toml.in',
+ install: true,
+ install_dir: docdir,
+ output: vte_gtk3_api_name + '.toml',
+ )
+
+ libvte_gtk3_docs = custom_target(
+ vte_gtk3_api_name,
+ command: [
+ gidocgen,
+ 'generate',
+ '--config', '@INPUT0@',
+ '--content-dir', meson.current_source_dir(),
+ '--fatal-warnings',
+ '--no-namespace-dir',
+ '--output-dir', '@OUTPUT@',
+ '--quiet',
+ '@INPUT1@',
+ ],
+ depend_files: [doc_sources,],
+ input: [
+ libvte_gtk3_docs_toml,
+ libvte_gtk3_gir[0],
+ ],
+ install: true,
+ install_dir: docdir,
+ output: vte_gtk3_api_name,
+ )
+
+endif # gtk3
if get_option('gtk4')
- subdir('gtk4')
-endif
+
+ libvte_gtk4_docs_toml = configure_file(
+ configuration: doc_conf,
+ input: 'vte-gtk4.toml.in',
+ install: true,
+ install_dir: docdir,
+ output: vte_gtk4_api_name + '.toml',
+ )
+
+ libvte_gtk4_docs = custom_target(
+ vte_gtk4_api_name,
+ command: [
+ gidocgen,
+ 'generate',
+ '--config', '@INPUT0@',
+ '--content-dir', meson.current_source_dir(),
+ '--fatal-warnings',
+ '--no-namespace-dir',
+ '--output-dir', '@OUTPUT@',
+ '--quiet',
+ '@INPUT1@',
+ ],
+ depend_files: [doc_sources,],
+ input: [
+ libvte_gtk4_docs_toml,
+ libvte_gtk4_gir[0],
+ ],
+ install: true,
+ install_dir: docdir,
+ output: vte_gtk4_api_name,
+ )
+
+endif # gtk4
diff --git a/doc/reference/vte-docs.xml b/doc/reference/vte-docs.xml
deleted file mode 100644
index 62b779d3..00000000
--- a/doc/reference/vte-docs.xml
+++ /dev/null
@@ -1,182 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
- "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
-[
- <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
- %gtkdocentities;
-]>
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <!--
- Copyright © 2009, 2010 Christian Persch
-
- This library is free software: you can redistribute it and/or modify
- it under the terms of the GNU Lesser General Public License as published
- by the Free Software Foundation, either version 3 of the License, or
- (at your option) any later version.
-
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU Lesser General Public License for more details.
-
- You should have received a copy of the GNU Lesser General Public License
- along with this library. If not, see <https://www.gnu.org/licenses/>.
- -->
-
- <bookinfo>
- <title>VTE Reference Manual</title>
- <releaseinfo>
- Documentation for VTE version &package_version;.
- The latest version of this documentation can be found on-line at the
- <ulink role="online-location" url="https://library.gnome.org/devel/vte/">GNOME Library</ulink>.
- </releaseinfo>
-
- <copyright>
- <year>2009</year>
- <year>2010</year>
- <holder>Christian Persch</holder>
- </copyright>
-
- <legalnotice>
- <para>
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the <citetitle>GNU Lesser General Public Licence</citetitle>, Version 3
- or (at your option) any later version published by the Free Software Foundation.
-
- You may obtain a copy of the <citetitle>GNU Lesser General Public Licence</citetitle>
- from the Free Software Foundation at
- <ulink type="http" url="https://www.gnu.org/licences/">GNU Licences web site</ulink>
- or by writing to:
-
- <address>
- The Free Software Foundation, Inc.,
- <street>51 Franklin St</street> – Fifth Floor,
- <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
- <country>USA</country>
- </address>
- </para>
- </legalnotice>
- </bookinfo>
-
- <part>
- <title>API Reference</title>
- <chapter>
- <xi:include href="xml/vte-terminal.xml"/>
- </chapter>
- <chapter>
- <xi:include href="xml/vte-regex.xml"/>
- </chapter>
- <chapter>
- <xi:include href="xml/vte-pty.xml"/>
- </chapter>
- <chapter>
- <xi:include href="xml/vte-version.xml"/>
- </chapter>
- </part>
-
- <chapter id="object-hierarchy">
- <title>Object Hierarchy</title>
- <xi:include href="xml/tree_index.sgml"/>
- </chapter>
-
- <index id="api-index-full">
- <title id="index-all">Index</title>
- <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-deprecated" role="deprecated">
- <title>Index of deprecated symbols</title>
- <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-40" role="0.40">
- <title>Index of new symbols in 0.40</title>
- <xi:include href="xml/api-index-0.40.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-44" role="0.44">
- <title>Index of new symbols in 0.44</title>
- <xi:include href="xml/api-index-0.44.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-46" role="0.46">
- <title>Index of new symbols in 0.46</title>
- <xi:include href="xml/api-index-0.46.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-48" role="0.48">
- <title>Index of new symbols in 0.48</title>
- <xi:include href="xml/api-index-0.48.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-50" role="0.50">
- <title>Index of new symbols in 0.50</title>
- <xi:include href="xml/api-index-0.50.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-52" role="0.52">
- <title>Index of new symbols in 0.52</title>
- <xi:include href="xml/api-index-0.52.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-54" role="0.54">
- <title>Index of new symbols in 0.54</title>
- <xi:include href="xml/api-index-0.54.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-56" role="0.56">
- <title>Index of new symbols in 0.56</title>
- <xi:include href="xml/api-index-0.56.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-58" role="0.58">
- <title>Index of new symbols in 0.58</title>
- <xi:include href="xml/api-index-0.58.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-60" role="0.60">
- <title>Index of new symbols in 0.60</title>
- <xi:include href="xml/api-index-0.60.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-62" role="0.62">
- <title>Index of new symbols in 0.62</title>
- <xi:include href="xml/api-index-0.62.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-64" role="0.64">
- <title>Index of new symbols in 0.64</title>
- <xi:include href="xml/api-index-0.64.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-66" role="0.66">
- <title>Index of new symbols in 0.66</title>
- <xi:include href="xml/api-index-0.66.xml"><xi:fallback /></xi:include>
- </index>
- <index id="api-index-0-68" role="0.68">
- <title>Index of new symbols in 0.68</title>
- <xi:include href="xml/api-index-0.68.xml"><xi:fallback /></xi:include>
- </index>
-
- <xi:include href="xml/annotation-glossary.xml"></xi:include>
-
- <appendix id="licence">
- <title>Licence</title>
-
- <para>
- This library is free software; you can redistribute it and/or
- modify it under the terms of the <citetitle>GNU Lesser General Public
- Licence</citetitle> as published by the Free Software Foundation; either
- version 3 of the Licence, or (at your option) any later version.
- </para>
-
- <para>
- This library is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- <citetitle>GNU Lesser General Public Licence</citetitle> for
- more details.
- </para>
-
- <para>
- You may obtain a copy of the <citetitle>GNU Lesser General Public Licence</citetitle>
- from the Free Software Foundation at
- <ulink type="http" url="https://www.gnu.org/licences/">GNU Licences web site</ulink>
- or by writing to:
-
- <address>
- The Free Software Foundation, Inc.,
- <street>51 Franklin St</street> – Fifth Floor,
- <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
- <country>USA</country>
- </address>
- </para>
- </appendix>
-
-</book>
diff --git a/doc/reference/vte-overrides.txt.in b/doc/reference/vte-overrides.txt.in
deleted file mode 100644
index e69de29b..00000000
--- a/doc/reference/vte-overrides.txt.in
+++ /dev/null
diff --git a/doc/reference/vte-sections.txt.in b/doc/reference/vte-sections.txt.in
deleted file mode 100644
index 4c9680f0..00000000
--- a/doc/reference/vte-sections.txt.in
+++ /dev/null
@@ -1,281 +0,0 @@
-<SECTION>
-<FILE>vte-terminal</FILE>
-<TITLE>VteTerminal</TITLE>
-VteTerminal
-VteAlign
-VteCursorBlinkMode
-VteCursorShape
-VteEraseBinding
-VteTextBlinkMode
-VteFormat
-VteWriteFlags
-VteSelectionFunc
-vte_terminal_new
-vte_terminal_feed
-vte_terminal_feed_child
-vte_terminal_select_all
-vte_terminal_unselect_all
-vte_terminal_copy_clipboard_format
-vte_terminal_paste_clipboard
-vte_terminal_paste_text
-vte_terminal_copy_primary
-vte_terminal_paste_primary
-vte_terminal_set_size
-vte_terminal_set_font_scale
-vte_terminal_get_font_scale
-vte_terminal_set_audible_bell
-vte_terminal_get_audible_bell
-vte_terminal_set_allow_bold
-vte_terminal_get_allow_bold
-vte_terminal_set_bold_is_bright
-vte_terminal_get_bold_is_bright
-vte_terminal_set_allow_hyperlink
-vte_terminal_get_allow_hyperlink
-vte_terminal_set_enable_fallback_scrolling
-vte_terminal_get_enable_fallback_scrolling
-vte_terminal_set_scroll_on_output
-vte_terminal_get_scroll_on_output
-vte_terminal_set_scroll_on_keystroke
-vte_terminal_get_scroll_on_keystroke
-vte_terminal_set_scroll_unit_is_pixels
-vte_terminal_get_scroll_unit_is_pixels
-vte_terminal_set_cell_height_scale
-vte_terminal_get_cell_height_scale
-vte_terminal_set_cell_width_scale
-vte_terminal_get_cell_width_scale
-vte_terminal_set_color_bold
-vte_terminal_set_color_foreground
-vte_terminal_set_color_background
-vte_terminal_set_color_cursor
-vte_terminal_set_color_cursor_foreground
-vte_terminal_set_color_highlight
-vte_terminal_set_color_highlight_foreground
-vte_terminal_set_colors
-vte_terminal_set_default_colors
-vte_terminal_set_cursor_shape
-vte_terminal_get_cursor_shape
-vte_terminal_get_cursor_blink_mode
-vte_terminal_set_cursor_blink_mode
-vte_terminal_get_text_blink_mode
-vte_terminal_set_text_blink_mode
-vte_terminal_set_scrollback_lines
-vte_terminal_get_scrollback_lines
-vte_terminal_set_font
-vte_terminal_get_font
-vte_terminal_get_has_selection
-vte_terminal_set_backspace_binding
-vte_terminal_set_delete_binding
-vte_terminal_set_mouse_autohide
-vte_terminal_get_mouse_autohide
-vte_terminal_set_enable_bidi
-vte_terminal_get_enable_bidi
-vte_terminal_set_enable_shaping
-vte_terminal_get_enable_shaping
-vte_terminal_reset
-vte_terminal_get_text
-vte_terminal_get_text_range
-vte_terminal_get_cursor_position
-#if VTE_GTK == 3
-vte_terminal_hyperlink_check_event
-#endif
-vte_terminal_match_add_regex
-vte_terminal_match_remove
-vte_terminal_match_remove_all
-vte_terminal_match_check
-#if VTE_GTK == 3
-vte_terminal_match_check_event
-#endif
-vte_terminal_match_set_cursor_name
-vte_terminal_set_cjk_ambiguous_width
-vte_terminal_get_cjk_ambiguous_width
-vte_terminal_set_word_char_exceptions
-vte_terminal_get_word_char_exceptions
-vte_terminal_set_input_enabled
-vte_terminal_get_input_enabled
-vte_terminal_get_enable_sixel
-vte_terminal_set_enable_sixel
-vte_terminal_write_contents_sync
-vte_terminal_search_find_next
-vte_terminal_search_find_previous
-vte_terminal_search_get_regex
-vte_terminal_search_get_wrap_around
-vte_terminal_search_set_regex
-vte_terminal_search_set_wrap_around
-#if VTE_GTK == 3
-vte_terminal_event_check_regex_array
-vte_terminal_event_check_regex_simple
-#endif /* VTE_GTK */
-vte_terminal_get_xalign
-vte_terminal_set_xalign
-vte_terminal_get_yalign
-vte_terminal_set_yalign
-vte_terminal_get_xfill
-vte_terminal_set_xfill
-vte_terminal_get_yfill
-vte_terminal_set_yfill
-
-<SUBSECTION>
-VteFeatureFlags
-vte_get_user_shell
-vte_get_features
-vte_get_feature_flags
-vte_get_encodings
-vte_get_encoding_supported
-
-<SUBSECTION>
-VteTerminalSpawnAsyncCallback
-vte_terminal_spawn_async
-vte_terminal_spawn_with_fds_async
-vte_terminal_get_pty
-vte_terminal_set_pty
-vte_terminal_pty_new_sync
-vte_terminal_watch_child
-
-#if VTE_GTK == 3
-<SUBSECTION>
-vte_terminal_set_clear_background
-vte_terminal_get_color_background_for_draw
-#endif /* VTE_GTK == 3 */
-
-<SUBSECTION Standard>
-VTE_TYPE_ALIGN
-vte_align_get_type
-VTE_TYPE_CURSOR_BLINK_MODE
-vte_cursor_blink_mode_get_type
-VTE_TYPE_CURSOR_SHAPE
-vte_cursor_shape_get_type
-VTE_TYPE_ERASE_BINDING
-vte_erase_binding_get_type
-VTE_TYPE_TEXT_BLINK_MODE
-vte_text_blink_mode_get_type
-VTE_TYPE_FORMAT
-vte_format_get_type
-VTE_TYPE_WRITE_FLAGS
-vte_write_flags_get_type
-VTE_TYPE_TERMINAL
-vte_terminal_get_type
-VTE_IS_TERMINAL
-VTE_TERMINAL
-VTE_TERMINAL_GET_CLASS
-VTE_IS_TERMINAL_CLASS
-VTE_TERMINAL_CLASS
-
-<SUBSECTION Binding Accessors>
-vte_terminal_get_char_height
-vte_terminal_get_char_width
-vte_terminal_get_column_count
-vte_terminal_get_row_count
-vte_terminal_get_window_title
-vte_terminal_get_current_directory_uri
-vte_terminal_get_current_file_uri
-
-<SUBSECTION Deprecated>
-vte_terminal_copy_clipboard
-vte_terminal_match_set_cursor
-#if VTE_GTK == 3
-vte_terminal_match_set_cursor_type
-vte_terminal_match_add_gregex
-vte_terminal_search_get_gregex
-vte_terminal_search_set_gregex
-vte_terminal_event_check_gregex_simple
-#endif /* VTE_GTK == 3 */
-vte_terminal_spawn_sync
-#if VTE_GTK == 3
-vte_terminal_get_geometry_hints
-vte_terminal_set_geometry_hints_for_window
-#endif /* VTE_GTK == 3 */
-vte_terminal_get_icon_title
-vte_terminal_set_encoding
-vte_terminal_get_encoding
-vte_terminal_get_text_include_trailing_spaces
-vte_terminal_set_rewrap_on_resize
-vte_terminal_get_rewrap_on_resize
-vte_terminal_feed_child_binary
-
-<SUBSECTION Private>
-VteCharAttributes
-VteTerminalClassPrivate
-vte_set_test_flags
-VTE_TEST_FLAGS_ALL
-VTE_TEST_FLAGS_NONE
-</SECTION>
-
-<SECTION>
-<FILE>vte-regex</FILE>
-<TITLE>VteRegex</TITLE>
-VteRegex
-vte_regex_ref
-vte_regex_unref
-vte_regex_new_for_match
-vte_regex_new_for_search
-vte_regex_jit
-vte_regex_substitute
-VteRegexError
-
-<SUBSECTION Standard>
-VTE_TYPE_REGEX
-vte_regex_get_type
-VTE_TYPE_REGEX_ERROR
-vte_regex_error_get_type
-VTE_REGEX_ERROR
-vte_regex_error_quark
-VTE_REGEX_FLAGS_DEFAULT
-</SECTION>
-
-<SECTION>
-<FILE>vte-pty</FILE>
-<TITLE>Vte PTY</TITLE>
-VtePtyFlags
-VtePtyError
-VtePty
-vte_pty_new_sync
-vte_pty_new_foreign_sync
-vte_pty_child_setup
-vte_pty_get_fd
-vte_pty_set_size
-vte_pty_get_size
-vte_pty_set_utf8
-
-<SUBSECTION>
-VTE_SPAWN_NO_PARENT_ENVV
-VTE_SPAWN_NO_SYSTEMD_SCOPE
-VTE_SPAWN_REQUIRE_SYSTEMD_SCOPE
-vte_pty_spawn_async
-vte_pty_spawn_with_fds_async
-vte_pty_spawn_finish
-
-<SUBSECTION Standard>
-vte_pty_flags_get_type
-VTE_TYPE_PTY_FLAGS
-vte_pty_error_get_type
-VTE_TYPE_PTY_ERROR
-vte_pty_error_quark
-VTE_PTY_ERROR
-vte_pty_get_type
-VTE_TYPE_PTY
-VTE_PTY
-VTE_PTY_CLASS
-VTE_IS_PTY
-VTE_IS_PTY_CLASS
-VTE_PTY_GET_CLASS
-VtePtyClass
-
-<SUBSECTION Deprecated>
-vte_pty_close
-</SECTION>
-
-<SECTION>
-<FILE>vte-version</FILE>
-<TITLE>Version Information</TITLE>
-
-VTE_MAJOR_VERSION
-vte_get_major_version
-VTE_MINOR_VERSION
-vte_get_minor_version
-VTE_MICRO_VERSION
-vte_get_micro_version
-
-<SUBSECTION>
-VTE_CHECK_VERSION
-
-</SECTION>
diff --git a/doc/reference/vte.types.in b/doc/reference/vte.types.in
deleted file mode 100644
index d7db2a09..00000000
--- a/doc/reference/vte.types.in
+++ /dev/null
@@ -1,17 +0,0 @@
-#include <glib.h>
-#include <glib-object.h>
-#include <gio/gio.h>
-#include <gtk/gtk.h>
-#include "vte.h"
-
-vte_pty_get_type
-vte_terminal_get_type
-vte_regex_get_type
-
-vte_pty_error_get_type
-vte_pty_flags_get_type
-vte_cursor_blink_mode_get_type
-vte_cursor_shape_get_type
-vte_erase_binding_get_type
-vte_write_flags_get_type
-vte_regex_error_get_type