aboutsummaryrefslogtreecommitdiff
path: root/doc/reference/CrystFEL-docs.sgml
diff options
context:
space:
mode:
authorThomas White <taw@bitwiz.org.uk>2011-03-26 20:26:06 +0100
committerThomas White <taw@physics.org>2012-02-22 15:27:21 +0100
commitcf481c5e99e6923358687d66fd6afecc95625a57 (patch)
treead847b8243eda52ffc8081880dd402dc39e5fbed /doc/reference/CrystFEL-docs.sgml
parent03acd73808f6f21bbfc38300796b24ecf823a697 (diff)
Add documentation via gtk-doc
Diffstat (limited to 'doc/reference/CrystFEL-docs.sgml')
-rw-r--r--doc/reference/CrystFEL-docs.sgml39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/reference/CrystFEL-docs.sgml b/doc/reference/CrystFEL-docs.sgml
new file mode 100644
index 00000000..08f97f3d
--- /dev/null
+++ b/doc/reference/CrystFEL-docs.sgml
@@ -0,0 +1,39 @@
+<?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'">
+]>
+<book id="index">
+ <bookinfo>
+ <title>CrystFEL Reference Manual</title>
+ <releaseinfo>
+ For CrystFEL 0.2.0.
+ </releaseinfo>
+ This is the internal documentation for CrystFEL. Unless you are looking at
+ the code, writing new programs or fixing bugs, you should not need to read
+ this.
+ </bookinfo>
+
+ <chapter>
+ <title>Images</title>
+ <xi:include href="xml/image.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Handling reflection data</title>
+ <xi:include href="xml/reflist.xml"/>
+ <xi:include href="xml/reflitemlist.xml"/>
+ </chapter>
+
+ <chapter>
+ <title>Miscellaneous</title>
+ <xi:include href="xml/quaternion.xml"/>
+ <xi:include href="xml/utils.xml"/>
+ </chapter>
+
+ <index id="api-index-full">
+ <title>API Index</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+ </index>
+</book>