shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2024-12-22 17:35:55 +03:00
Code Issues Projects Releases Wiki Activity
f6d308f130
ostree/apidoc/ostree-docs.xml

44 lines
1.7 KiB
XML
Raw Normal View History

Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
<?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 version SYSTEM "version.xml">
]>
<book id="index">
<bookinfo>
Rewrite manual in mkdocs I don't much like Docbook (and am considering converting the man pages too), but let's start with the manual. I looked at various documentation generators (there are a lot), and I had a few requirements: - Markdown - Packaged in Fedora - Suitable for upload to a static webserver `mkdocs` seems to fit the bill.
2016-01-28 00:56:16 +03:00
<title>OSTree API references</title>
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
<releaseinfo>for OSTree &version;</releaseinfo>
</bookinfo>
<chapter xml:id="reference">
<title>API Reference</title>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<xi:include href="xml/ostree-core.xml"/>
<xi:include href="xml/ostree-repo.xml"/>
<xi:include href="xml/ostree-mutable-tree.xml"/>
<xi:include href="xml/ostree-sysroot.xml"/>
<xi:include href="xml/ostree-async-progress.xml"/>
<xi:include href="xml/ostree-sepolicy.xml"/>
<xi:include href="xml/ostree-sysroot-upgrader.xml"/>
<xi:include href="xml/ostree-gpg-verify-result.xml"/>
apidoc: add API documentation for signing interface Add the documentation for all public functions. Signed-off-by: Denis Pynkin <denis.pynkin@collabora.com>
2019-11-10 16:51:23 +03:00
<xi:include href="xml/ostree-sign.xml"/>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<xi:include href="xml/ostree-bootconfig-parser.xml"/>
<xi:include href="xml/ostree-chain-input-stream.xml"/>
<xi:include href="xml/ostree-checksum-input-stream.xml"/>
apidoc: add missing page includes This fixes some missing sections in API reference, adding all the relevant includes.
2022-03-04 16:56:38 +03:00
<xi:include href="xml/ostree-content-writer.xml"/>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<xi:include href="xml/ostree-deployment.xml"/>
<xi:include href="xml/ostree-diff.xml"/>
apidoc: add missing page includes This fixes some missing sections in API reference, adding all the relevant includes.
2022-03-04 16:56:38 +03:00
<xi:include href="xml/ostree-kernel-args.xml"/>
<xi:include href="xml/ostree-ref.xml"/>
<xi:include href="xml/ostree-remote.xml"/>
docs: Get API docs working again This changes around a few things that didn't work for me: * Section names seem to be ostree-* instead of libostree-* * Also XML files are ostree-* (they didn't show up at all) - gtk-doc doesn't seem to parse const _OSTREE_PUBLIC correctly * pull documentation is now on the actual functions rather than stubs * Update gitignore with some more files And there some changes to make gtk-doc give fewer warnings (not finished) Closes: #327 Approved by: cgwalters
2016-06-05 01:16:05 +03:00
<xi:include href="xml/ostree-repo-file.xml"/>
apidoc: add missing page includes This fixes some missing sections in API reference, adding all the relevant includes.
2022-03-04 16:56:38 +03:00
<xi:include href="xml/ostree-repo-finder.xml"/>
<xi:include href="xml/ostree-repo-remote-finder.xml"/>
<xi:include href="xml/ostree-version.xml"/>
Add gtk-doc support Yes, it's really me. Colin Walters. Writing documentation. You don't need to do a DNA test.
2013-08-17 06:54:35 +04:00
<index id="api-index-full">
<title>API Index</title>
<xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
</index>
</chapter>
</book>
Reference in New Issue Copy Permalink