summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Griffis <pgriffis@igalia.com>2020-09-19 19:57:01 -0700
committerPatrick Griffis <pgriffis@igalia.com>2020-09-20 12:27:22 -0700
commit5156e40631dc3f773d2096a5a32e5b34d850694f (patch)
treea0129febcfbcbc3e6f809fc6f191077666209fad
parent80ff89a9734a9752329c0579a1131301337357bd (diff)
downloadlibsoup-5156e40631dc3f773d2096a5a32e5b34d850694f.tar.gz
docs: Use XML for main docs file
-rw-r--r--docs/reference/libsoup-3.0-docs.xml (renamed from docs/reference/libsoup-3.0-docs.sgml)25
-rw-r--r--docs/reference/meson.build3
2 files changed, 17 insertions, 11 deletions
diff --git a/docs/reference/libsoup-3.0-docs.sgml b/docs/reference/libsoup-3.0-docs.xml
index 725a4926..0d415bab 100644
--- a/docs/reference/libsoup-3.0-docs.sgml
+++ b/docs/reference/libsoup-3.0-docs.xml
@@ -1,9 +1,12 @@
<?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/2001/XInclude">
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+<book xmlns="http://docbook.org/ns/docbook" id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
<title>libsoup Reference Manual</title>
+ <releaseinfo>
+ This documentation is for libsoup 3.0 which is in development.
+ You can find older versions online at <ulink role="online-location" url="https://developer.gnome.org/libsoup/stable/">https://developer.gnome.org/libsoup/stable/</ulink>.
+ </releaseinfo>
</bookinfo>
<chapter>
@@ -26,7 +29,6 @@
<xi:include href="xml/soup-message-headers.xml"/>
<xi:include href="xml/soup-message-body.xml"/>
<xi:include href="xml/soup-method.xml"/>
- <xi:include href="xml/soup-misc.xml"/>
<xi:include href="xml/soup-multipart.xml"/>
<xi:include href="xml/soup-multipart-input-stream.xml"/>
<xi:include href="xml/soup-request.xml"/>
@@ -61,12 +63,17 @@
<xi:include href="xml/soup-websocket.xml"/>
</chapter>
- <index>
- <title>Index</title>
+ <index id="api-index-full">
+ <title>Index of all symbols</title>
+ <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
- <xi:include href="xml/annotation-glossary.xml">
- <xi:fallback />
- </xi:include>
+ <index id="api-index-deprecated" role="deprecated">
+ <title>Index of deprecated symbols</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/meson.build b/docs/reference/meson.build
index e6c6658b..bbdc0054 100644
--- a/docs/reference/meson.build
+++ b/docs/reference/meson.build
@@ -43,7 +43,6 @@ ignore_headers = [
]
mkdb_args = [
- '--sgml-mode',
'--output-format=xml'
]
@@ -54,7 +53,7 @@ scan_args = [
]
gnome.gtkdoc('libsoup-3.0',
- main_sgml : 'libsoup-3.0-docs.sgml',
+ main_xml : 'libsoup-3.0-docs.xml',
src_dir : srcdir,
ignore_headers : ignore_headers,
namespace : 'soup',