[pybliographer] Update documentation system to use gnome-doc-utils
- From: Zoltan Kota <zkota src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pybliographer] Update documentation system to use gnome-doc-utils
- Date: Mon, 30 Aug 2010 13:54:27 +0000 (UTC)
commit c023b7c11c01c8c75739c54d43a2ef0c438b62d3
Author: Zoltan Kota <zoltank gmail com>
Date: Mon Aug 30 15:57:16 2010 +0200
Update documentation system to use gnome-doc-utils
Makefile.am | 3 +-
Pyblio/version.py.in | 2 +-
autogen.sh | 2 +
configure.ac | 4 ++-
help/C/Makefile.am | 32 ----------------------------
help/C/pybliographer-C.omf | 31 ---------------------------
help/C/pybliographer.xml | 50 +++++++++++++++++++++++--------------------
help/Makefile.am | 22 ++++++++++++++++--
help/pybliographer.omf.in | 9 ++++++++
9 files changed, 63 insertions(+), 92 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index a49fe97..544bc58 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -57,7 +57,8 @@ EXTRA_DIST = setup-check.py \
pybliographic.desktop.in \
pybliographic.png \
pybliographic-logo.png \
- pybliographic-viewer.png
+ pybliographic-viewer.png \
+ gnome-doc-utils.make
dist-hook:
diff --git a/Pyblio/version.py.in b/Pyblio/version.py.in
index 21078c6..96f5e99 100644
--- a/Pyblio/version.py.in
+++ b/Pyblio/version.py.in
@@ -2,6 +2,6 @@
datadir = "@p_datadir@"
pybdir = "@datapyb@"
-localedir = "@localedir@"
+localedir = "@locale_dir@"
version = "@version@"
diff --git a/autogen.sh b/autogen.sh
index 89cc9a8..71ff473 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -24,6 +24,8 @@ run ()
$* || error "while running $*"
}
+run gnome-doc-prepare --copy --force
+
run aclocal ${aclocal_extra}
run autoconf
run automake -a
diff --git a/configure.ac b/configure.ac
index d33815d..bb9575e 100644
--- a/configure.ac
+++ b/configure.ac
@@ -76,6 +76,9 @@ fi
dnl NLS is now hand-managed for python.
+# Documentation
+GNOME_DOC_INIT
+
AC_CONFIG_FILES(
Makefile
po/Makefile
@@ -90,7 +93,6 @@ AC_CONFIG_FILES(
Pyblio/ConfDir/Makefile
Pyblio/Style/Makefile
help/Makefile
- help/C/Makefile
Styles/Makefile
)
diff --git a/help/C/pybliographer.xml b/help/C/pybliographer.xml
index c268fab..ddffa14 100644
--- a/help/C/pybliographer.xml
+++ b/help/C/pybliographer.xml
@@ -17,6 +17,10 @@
<book id="index" lang="en">
<title>&app; Manual V&manrevision;</title>
<bookinfo>
+ <abstract role="description">
+ <para>&app; is a tool for managing bibliographic databases. It can be
+ used for searching, editing, reformatting, etc.</para>
+ </abstract>
<copyright>
<year>2003-2010</year>
<holder>Zoltán Kóta</holder>
@@ -29,7 +33,7 @@
&legal;
<authorgroup>
- <author>
+ <author role="maintainer">
<firstname>Zoltán</firstname>
<surname>Kóta</surname>
</author>
@@ -42,22 +46,29 @@
<revhistory>
<revision>
- <revnumber>&app; Manual V&manrevision;</revnumber>
- <date>&date;</date>
+ <revnumber>&app; Documentation</revnumber>
+ <date>1999</date>
+ <revdescription>
+ <para role="author">Frédéric Gobry</para>
+ </revdescription>
+ </revision>
+ <revision>
+ <revnumber>&app; Manual V2.1</revnumber>
+ <date>January 2004</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
</revision>
<revision>
- <revnumber>&app; Manual V2.6</revnumber>
- <date>October 2008</date>
+ <revnumber>&app; Manual V2.2</revnumber>
+ <date>March 2004</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
</revision>
<revision>
- <revnumber>&app; Manual V2.5</revnumber>
- <date>February 2005</date>
+ <revnumber>&app; Manual V2.3</revnumber>
+ <date>June 2004</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
@@ -70,33 +81,26 @@
</revdescription>
</revision>
<revision>
- <revnumber>&app; Manual V2.3</revnumber>
- <date>June 2004</date>
+ <revnumber>&app; Manual V2.5</revnumber>
+ <date>February 2005</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
</revision>
<revision>
- <revnumber>&app; Manual V2.2</revnumber>
- <date>March 2004</date>
+ <revnumber>&app; Manual V2.6</revnumber>
+ <date>October 2008</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
</revision>
<revision>
- <revnumber>&app; Manual V2.1</revnumber>
- <date>January 2004</date>
+ <revnumber>&app; Manual V&manrevision;</revnumber>
+ <date>&date;</date>
<revdescription>
<para role="author">Zoltán Kóta, Frédéric Gobry</para>
</revdescription>
</revision>
- <revision>
- <revnumber>&app; Documentation</revnumber>
- <date>1999</date>
- <revdescription>
- <para role="author">Frédéric Gobry</para>
- </revdescription>
- </revision>
</revhistory>
<releaseinfo>This manual describes version &appversion; of &app;.
@@ -206,10 +210,10 @@
<title>What's New in &app; &appversion;</title>
<para>
You can find a list of bugs fixed and features added
- in the <filename>News</filename> file supplied with the package.
+ in the <filename>News</filename> and <filename>ChangeLog
+ </filename> files supplied with the package.
See the source tarball of pybliographer, or the default doc directory
- of your distribution (e.g. /usr/share/doc/pybliographer). You can
- also browse the source code repository online.
+ of your distribution (e.g. /usr/share/doc/pybliographer).
</para>
</sect1>
diff --git a/help/Makefile.am b/help/Makefile.am
index 9f0b1ad..632ccd8 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -18,7 +18,23 @@
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
-SUBDIRS = C
+AUTOMAKE_OPTIONS = -Wno-portability
+
+include $(top_srcdir)/gnome-doc-utils.make
+dist-hook: doc-dist-hook
+
+DOC_MODULE = pybliographer
+DOC_ENTITIES = legal.xml
+DOC_INCLUDES =
+DOC_FIGURES = figures/edit.png \
+ figures/edit2.png \
+ figures/fields.png \
+ figures/format.png \
+ figures/main.png \
+ figures/medline.png \
+ figures/open.png \
+ figures/search.png \
+ figures/sort.png
+
+DOC_LINGUAS =
-doc:
- happydoc -d api $(top_srcdir)/Pyblio
diff --git a/help/pybliographer.omf.in b/help/pybliographer.omf.in
new file mode 100644
index 0000000..0286d20
--- /dev/null
+++ b/help/pybliographer.omf.in
@@ -0,0 +1,9 @@
+<?xml version="1.0" standalone="no"?>
+<omf>
+ <resource>
+ <subject category="GNOME|Applications|Office"/>
+ <type>user's guide</type>
+ <relation seriesid="ef478e44-3f87-11d8-99e5-aa7db3d8400c"/>
+ <rights type="GNU FDL" license.version="1.1" holder="Frederic Gobry"/>
+ </resource>
+</omf>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]