gplate/gplate

Remove the old gtk-doc setup

14 months ago, Gary Kramlich
2b8062687afa
Parents 2f9a06d936e8
Children 6eed44f77d65
Remove the old gtk-doc setup
--- a/CMakeLists.txt Sat Mar 04 10:31:36 2023 -0600
+++ b/CMakeLists.txt Sat Mar 04 10:33:46 2023 -0600
@@ -71,7 +71,6 @@
###############################################################################
add_subdirectory(gplate)
add_subdirectory(tests)
-add_subdirectory(doc)
###############################################################################
# Config Files
--- a/doc/CMakeLists.txt Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,1 +0,0 @@
-add_subdirectory(gplate)
--- a/doc/gplate/.gitignore Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,6 +0,0 @@
-overview.sgml
-gplate.*
-gplate-*.txt
-xml*
-html*
-sgml*
--- a/doc/gplate/CMakeLists.txt Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +0,0 @@
-configure_file(overview.sgml.in overview.sgml @ONLY)
-
-add_custom_target(doc
- COMMAND ./build-docs.sh
- DEPENDS ../../gplate/libgplate.so)
--- a/doc/gplate/Makefile.am Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,95 +0,0 @@
-## Process this file with automake to produce Makefile.in
-
-# We require automake 1.6 at least.
-AUTOMAKE_OPTIONS = 1.6
-
-# This is a blank Makefile.am for using gtk-doc.
-# Copy this to your project's API docs directory and modify the variables to
-# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
-# of using the various options.
-
-# The name of the module, e.g. 'glib'.
-DOC_MODULE=gplate
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# The directory containing the source code. Relative to $(srcdir).
-# gtk-doc will search all .c & .h files beneath here for inline comments
-# documenting the functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk
-DOC_SOURCE_DIR=../../gplate/
-
-# Extra options to pass to gtkdoc-scangobj. Not normally needed.
-SCANGOBJ_OPTIONS=
-
-# Extra options to supply to gtkdoc-scan.
-# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
-SCAN_OPTIONS=
-
-# Extra options to supply to gtkdoc-mkdb.
-# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
-MKDB_OPTIONS=--sgml-mode --output-format=xml
-
-# Extra options to supply to gtkdoc-mktmpl
-# e.g. MKTMPL_OPTIONS=--only-section-tmpl
-MKTMPL_OPTIONS=
-
-# Extra options to supply to gtkdoc-fixref. Not normally needed.
-# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
-FIXXREF_OPTIONS=
-
-# Used for dependencies. The docs will be rebuilt if any of these change.
-# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
-# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
-HFILE_GLOB=$(top_srcdir)/gplate/*.h
-CFILE_GLOB=$(top_srcdir)/gplate/*.c
-
-# Header files to ignore when scanning.
-# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=
-
-# Images to copy into HTML directory.
-# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
-HTML_IMAGES=
-
-# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
-# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
-content_files=overview.sgml
-
-# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
-# These files must be listed here *and* in content_files
-# e.g. expand_content_files=running.sgml
-expand_content_files=overview.sgml
-
-# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
-# Only needed if you are using gtkdoc-scangobj to dynamically query widget
-# signals and properties.
-# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
-# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
-INCLUDES=-I$(top_srcdir)
-
-GTKDOC_CFLAGS=\
- $(GLIB_CFLAGS)
-
-GTKDOC_LIBS=\
- $(GLIB_LIBS) \
- $(top_builddir)/gplate/libgplate.la
-
-# This includes the standard gtk-doc make rules, copied by gtkdocize.
-include $(top_srcdir)/gtk-doc.make
-
-# Other files to distribute
-# e.g. EXTRA_DIST += version.xml.in
-EXTRA_DIST += \
- overview.sgml.in \
- overview.sgml
-
-# Files not to distribute
-# for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
-# for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
-#DISTCLEANFILES +=
-
-# Comment this out if you want your docs-status tested during 'make check'
-#TESTS = $(GTKDOC_CHECK)
-
--- a/doc/gplate/build-docs.sh Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,52 +0,0 @@
-#!/bin/sh -e
-#
-# build-docs.sh - Build documentation with gtk-doc.
-#
-DOC_MODULE=gplate
-SCAN_OPTIONS=
-SCANGOBJ_OPTIONS=
-MKDB_OPTIONS="--xml-mode --output-format=xml"
-DOC_MAIN_SGML_FILE=${DOC_MODULE}-docs.sgml
-
-CONTENT_FILES="overview.sgml"
-EXPAND_CONTENT_FILES="overview.sgml"
-
-DOC_SOURCE_DIR="$(pwd)"
-SOURCE_DIR="$(realpath ../../gplate)"
-
-export CFLAGS="$(pkg-config --cflags gobject-2.0) -I../../gplate"
-export LDFLAGS="$(pkg-config --libs gobject-2.0) -L../../gplate -lgplate"
-export LD_LIBRARY_PATH="$(realpath `pwd`/../../gplate)"
-
-echo "CFLAGS=${CFLAGS}"
-echo "LDFLAGS=${LDFLAGS}"
-
-echo "Cleaning docs..."
-rm -Rf gplate.* gplate-*.txt xml* html* sgml*
-
-echo "Scanning sources..."
-gtkdoc-scan --module=${DOC_MODULE} "--source-dir=${SOURCE_DIR}" ${SCAN_OPTIONS}
-
-echo "Filtering unimplemented objects from gplate.types..."
-# filter the unimplemented ones out.
-sed -i 's/.*object_variable_get.*//;s/.*directory_variable_get.*//;s/.*file_variable_get.*//;' gplate.types
-
-echo "Scanning GObjects..."
-gtkdoc-scangobj ${SCANGOBJ_OPTIONS} --module=${DOC_MODULE}
-
-echo "Creating database..."
-gtkdoc-mkdb --module=${DOC_MODULE} \
- --expand-content-files="${EXPAND_CONTENT_FILES}" ${MKDB_OPTIONS} \
- --main-sgml-file=${DOC_MAIN_SGML_FILE} --source-dir="${SOURCE_DIR}"
-
-echo "Creating HTML..."
-rm -Rf html; mkdir html
-cd html
-gtkdoc-mkhtml ${MKHTML_OPTIONS} ${DOC_MODULE} ../${DOC_MAIN_SGML_FILE}
-cd ..
-
-echo "Fixing cross-references..."
-gtkdoc-fixxref --module=${DOC_MODULE} --module-dir=html --html-dir=html \
- ${FIXXREF_OPTIONS}
-
-echo "Done."
--- a/doc/gplate/gplate-docs.sgml Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,78 +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">
-<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
- <bookinfo>
- <title>GPlate Reference Manual</title>
- <releaseinfo>
- <xi:include href="./overview.sgml"/>
- </releaseinfo>
- </bookinfo>
-
- <part id="object-ref">
- <title>GPlate Object Reference</title>
-
- <partintro id="object-ref-partintro">
- <para>
- </para>
- </partintro>
-
- <chapter id="object-hierarchy">
- <title>Object Hierarchy</title>
-
- <xi:include href="xml/tree_index.sgml"/>
- </chapter>
-
- <chapter id="object-templates">
- <title>Templates</title>
-
- <xi:include href="xml/gplate-template.xml"/>
- </chapter>
-
- <chapter id="object-tags">
- <title>Tags</title>
-
- <xi:include href="xml/gplate-tag.xml"/>
- <xi:include href="xml/gplate-code-tag.xml"/>
- <xi:include href="xml/gplate-comment-tag.xml"/>
- <xi:include href="xml/gplate-text-tag.xml"/>
- <xi:include href="xml/gplate-variable-tag.xml"/>
- </chapter>
-
- <chapter id="object-variables">
- <title>Variables</title>
-
- <xi:include href="xml/gplate-variable.xml"/>
- <xi:include href="xml/gplate-collection.xml"/>
- <xi:include href="xml/gplate-dictionary-variable.xml"/>
- <xi:include href="xml/gplate-iterator.xml"/>
- <xi:include href="xml/gplate-object-variable.xml"/>
- <xi:include href="xml/gplate-directory-variable.xml"/>
- <xi:include href="xml/gplate-file-variable.xml"/>
- </chapter>
-
- <chapter id="object-functions">
- <title>Functions</title>
-
- <xi:include href="xml/gplate-function.xml"/>
- <xi:include href="xml/gplate-include-function.xml"/>
- <xi:include href="xml/gplate-noop-function.xml"/>
- <xi:include href="xml/gplate-print-function.xml"/>
- <xi:include href="xml/gplate-text-function.xml"/>
- </chapter>
- </part>
-
- <part id="api-ref">
- <title>GPlate API Reference</title>
-
- <partintro id="api-ref-partintro">
- <para>
- </para>
- </partintro>
-
- <xi:include href="xml/gplate-library.xml"/>
- <xi:include href="xml/gplate-errors.xml"/>
- <xi:include href="xml/gplate-config.xml"/>
- <xi:include href="xml/gplate-util.xml"/>
- </part>
-</book>
--- a/doc/gplate/overview.sgml.in Sat Mar 04 10:31:36 2023 -0600
+++ /dev/null Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +0,0 @@
-<para>
-This documenation is for @PACKAGE@ @VERSION@. The latest version of this
-document can be found online at
-<ulink role="online-location" url="http://misc.guifications.org/doc/gplate/index.html">http://misc.guifications.org/doc/gplate</ulink>
-</para>