aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2018-05-17 15:31:45 +0200
committerThomas White <taw@physics.org>2018-05-17 15:39:22 +0200
commita9f48b6507b0326a34b84d7600f5eb791993eeb1 (patch)
treeb89b6e73477125336c35c6d7d9996bd8ebae7fd7 /doc
parent87fd650abf11da75e7abd2ff90821cf7cb041b91 (diff)
parenta9f4c0ff4376267d90d6e8f9a0b6c012ec0588a4 (diff)
Merge branch 'tom/cmake'
Diffstat (limited to 'doc')
-rw-r--r--doc/reference/libcrystfel/CrystFEL-docs.sgml7
-rw-r--r--doc/reference/libcrystfel/Makefile.am102
-rwxr-xr-xdoc/reference/libcrystfel/build-docs14
-rw-r--r--doc/reference/libcrystfel/xml/gtkdocentities.ent.cmake.in8
4 files changed, 25 insertions, 106 deletions
diff --git a/doc/reference/libcrystfel/CrystFEL-docs.sgml b/doc/reference/libcrystfel/CrystFEL-docs.sgml
index 6a1dabee..15d9f43f 100644
--- a/doc/reference/libcrystfel/CrystFEL-docs.sgml
+++ b/doc/reference/libcrystfel/CrystFEL-docs.sgml
@@ -33,7 +33,7 @@
<chapter>
<title>Unit cells</title>
- <xi:include href="xml/unitcell.xml"/>
+ <xi:include href="xml/cell.xml"/>
<xi:include href="xml/cell-utils.xml"/>
</chapter>
@@ -59,7 +59,7 @@
<chapter>
<title>Image filters</title>
- <xi:include href="xml/filter.xml"/>
+ <xi:include href="xml/filters.xml"/>
</chapter>
<chapter>
@@ -79,7 +79,7 @@
<chapter>
<title>Indexing</title>
- <xi:include href="xml/indexing.xml"><xi:fallback /></xi:include>
+ <xi:include href="xml/index.xml"><xi:fallback /></xi:include>
</chapter>
<chapter>
@@ -119,7 +119,6 @@
<chapter>
<title>Miscellaneous</title>
- <xi:include href="xml/quaternion.xml"/>
<xi:include href="xml/histogram.xml"/>
<xi:include href="xml/utils.xml"/>
</chapter>
diff --git a/doc/reference/libcrystfel/Makefile.am b/doc/reference/libcrystfel/Makefile.am
deleted file mode 100644
index e4f49b03..00000000
--- a/doc/reference/libcrystfel/Makefile.am
+++ /dev/null
@@ -1,102 +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=CrystFEL
-
-# Uncomment for versioned docs and specify the version of the module, e.g. '2'.
-#DOC_MODULE_VERSION=2
-
-
-# The top-level SGML file. You can change this if you want to.
-DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
-
-# Directories containing the source code, relative to $(srcdir).
-# gtk-doc will search all .c and .h files beneath these paths
-# for inline comments documenting functions and macros.
-# e.g. DOC_SOURCE_DIR=../../../gtk ../../../gdk
-DOC_SOURCE_DIR=../../../libcrystfel/src
-
-# 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-mkhtml
-MKHTML_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)/libcrystfel/src/*.h
-CFILE_GLOB=$(top_srcdir)/libcrystfel/src/*.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 to ignore when scanning. Use base file name, no paths
-# 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=
-
-# 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=
-
-# 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=
-GTKDOC_LIBS=
-
-# 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 +=
-
-# 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'
-#if ENABLE_GTK_DOC
-#TESTS_ENVIRONMENT = cd $(srcsrc) &&
-#TESTS = $(GTKDOC_CHECK)
-#endif
-
--include $(top_srcdir)/git.mk
diff --git a/doc/reference/libcrystfel/build-docs b/doc/reference/libcrystfel/build-docs
new file mode 100755
index 00000000..adb2137a
--- /dev/null
+++ b/doc/reference/libcrystfel/build-docs
@@ -0,0 +1,14 @@
+#!/bin/sh
+
+set -x
+DOC_MODULE=CrystFEL
+
+mkdir docs
+cd docs
+gtkdoc-scan --module=${DOC_MODULE} ../../libcrystfel/src/*.h
+gtkdoc-mkdb --module=${DOC_MODULE} --output-format=xml --source-dir=../../libcrystfel/src
+mkdir html
+cd html
+gtkdoc-mkhtml ${DOC_MODULE} ../CrystFEL-docs.sgml
+cd ..
+gtkdoc-fixxref --module=${DOC_MODULE} --module-dir=html
diff --git a/doc/reference/libcrystfel/xml/gtkdocentities.ent.cmake.in b/doc/reference/libcrystfel/xml/gtkdocentities.ent.cmake.in
new file mode 100644
index 00000000..3fd9b080
--- /dev/null
+++ b/doc/reference/libcrystfel/xml/gtkdocentities.ent.cmake.in
@@ -0,0 +1,8 @@
+<!ENTITY package "libcrystfel">
+<!ENTITY package_bugreport "taw@physics.org">
+<!ENTITY package_name "libcrystfel">
+<!ENTITY package_string "crystfel ${PROJECT_VERSION}+${GIT_SHA1}">
+<!ENTITY package_tarname "libcrystfel">
+<!ENTITY package_url "https://www.desy.de/~twhite/crystfel">
+<!ENTITY package_version "${PROJECT_VERSION}+${GIT_SHA1}">
+