[gnome-panel] Revert "remove libgnome-panel docs"
- From: Alberts Muktupāvels <muktupavels src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-panel] Revert "remove libgnome-panel docs"
- Date: Fri, 20 Dec 2019 18:06:59 +0000 (UTC)
commit 58ec5caee147b2c852d8ea38814464e66d0695b0
Author: Alberts Muktupāvels <alberts muktupavels gmail com>
Date: Fri Dec 20 19:38:19 2019 +0200
Revert "remove libgnome-panel docs"
This reverts commit 52f0e15a9fb3063bbec7415d4ba0846ab4c45fbc.
Makefile.am | 1 +
configure.ac | 4 +
docs/Makefile.am | 7 ++
docs/reference/Makefile.am | 7 ++
docs/reference/libgnome-panel/Makefile.am | 95 ++++++++++++++++++++++
.../libgnome-panel/libgnome-panel-docs.xml | 43 ++++++++++
.../libgnome-panel/libgnome-panel-overrides.txt | 0
7 files changed, 157 insertions(+)
---
diff --git a/Makefile.am b/Makefile.am
index f30d8388e..59d7806cb 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -6,6 +6,7 @@ SUBDIRS = \
gnome-panel \
libpanel-applet \
doc \
+ docs \
help \
data \
man \
diff --git a/configure.ac b/configure.ac
index 07d81acf1..f938a8db6 100644
--- a/configure.ac
+++ b/configure.ac
@@ -292,6 +292,10 @@ AC_CONFIG_FILES([
doc/reference/Makefile
doc/reference/libpanel-applet/Makefile
+ docs/Makefile
+ docs/reference/Makefile
+ docs/reference/libgnome-panel/Makefile
+
help/Makefile
help/clock/Makefile
help/fish/Makefile
diff --git a/docs/Makefile.am b/docs/Makefile.am
new file mode 100644
index 000000000..e77726355
--- /dev/null
+++ b/docs/Makefile.am
@@ -0,0 +1,7 @@
+NULL =
+
+SUBDIRS = \
+ reference \
+ $(NULL)
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
new file mode 100644
index 000000000..47ee70e46
--- /dev/null
+++ b/docs/reference/Makefile.am
@@ -0,0 +1,7 @@
+NULL =
+
+SUBDIRS = \
+ libgnome-panel \
+ $(NULL)
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference/libgnome-panel/Makefile.am b/docs/reference/libgnome-panel/Makefile.am
new file mode 100644
index 000000000..9a7d8d555
--- /dev/null
+++ b/docs/reference/libgnome-panel/Makefile.am
@@ -0,0 +1,95 @@
+NULL =
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE = libgnome-panel
+
+# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
+#DOC_MODULE_VERSION=2
+
+# The top-level XML file.
+DOC_MAIN_SGML_FILE = $(DOC_MODULE)-docs.xml
+
+# Directories containing the source code.
+# gtk-doc will search all .c and .h files beneath these paths
+# for inline comments documenting functions and macros.
+# e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
+DOC_SOURCE_DIR = $(top_srcdir)/libgnome-panel
+
+# Extra options to pass to gtkdoc-scangobj. Normally not needed.
+SCANGOBJ_OPTIONS =
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS = --rebuild-types --rebuild-sections
+
+# Extra options to supply to gtkdoc-mkdb
+# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
+MKDB_OPTIONS = --xml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-mkhtml
+MKHTML_OPTIONS =
+
+# Extra options to supply to gtkdoc-fixref. Normally not 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)/libgnome-panel/gp-*.h
+CFILE_GLOB = $(top_srcdir)/libgnome-panel/gp-*.c
+
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES =
+
+# Header files or dirs to ignore when scanning. Use base file/dir names
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
+IGNORE_HFILES = \
+ gp-applet-info-private.h \
+ gp-applet-private.h \
+ gp-enum-types.h \
+ gp-module-info-private.h \
+ $(NULL)
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES =
+
+# Extra files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.xml building.xml changes-2.0.xml
+content_files =
+
+# Files where gtk-doc abbrevations (#GtkWidget) are expanded
+# e.g. expand_content_files=running.xml
+expand_content_files =
+
+# 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. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+GTKDOC_CFLAGS = \
+ -I$(top_srcdir)/libgnome-panel \
+ -I$(top_builddir)/libgnome-panel \
+ $(LIBGNOME_PANEL_CFLAGS) \
+ $(NULL)
+
+GTKDOC_LIBS = \
+ $(top_builddir)/libgnome-panel/libgnome-panel.la \
+ $(LIBGNOME_PANEL_LIBS) \
+ $(NULL)
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Comment this out if you want 'make check' to test you doc status
+# and run some sanity checks
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = \
+ DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
+ SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
+TESTS = $(GTKDOC_CHECK)
+endif
+
+-include $(top_srcdir)/git.mk
diff --git a/docs/reference/libgnome-panel/libgnome-panel-docs.xml
b/docs/reference/libgnome-panel/libgnome-panel-docs.xml
new file mode 100644
index 000000000..515902919
--- /dev/null
+++ b/docs/reference/libgnome-panel/libgnome-panel-docs.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
+[
+ <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
+ <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+ %gtkdocentities;
+]>
+<book id="index">
+ <bookinfo>
+ <title>GNOME Panel Reference Manual</title>
+ <releaseinfo>
+ This document is for the GNOME Panel library, version &package_version;.
+ The latest version of this documentation can be found on-line at
+ <ulink role="online-location"
url="https://developer.gnome.org/libgnome-panel/unstable/">https://developer.gnome.org/libgnome-panel/unstable/</ulink>.
+ </releaseinfo>
+ </bookinfo>
+
+ <chapter>
+ <title>API Reference</title>
+ <xi:include href="xml/gp-applet.xml"/>
+ <xi:include href="xml/gp-applet-info.xml"/>
+ <xi:include href="xml/gp-module-info.xml"/>
+ <xi:include href="xml/gp-module.xml"/>
+ </chapter>
+
+ <chapter id="object-tree">
+ <title>Object Hierarchy</title>
+ <xi:include href="xml/tree_index.sgml"/>
+ </chapter>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <index id="deprecated-api-index" role="deprecated">
+ <title>Index of deprecated API</title>
+ <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+ </index>
+
+ <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+</book>
diff --git a/docs/reference/libgnome-panel/libgnome-panel-overrides.txt
b/docs/reference/libgnome-panel/libgnome-panel-overrides.txt
new file mode 100644
index 000000000..e69de29bb
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]