forked from Mirrors/flatpak-builder
Build html documentation from the man pages
This will be useful for putting the docs online.tingping/wmclass
parent
86d7dd73f9
commit
bf96dd248f
32
configure.ac
32
configure.ac
|
@ -326,6 +326,37 @@ AM_CONDITIONAL([ENABLE_GTK_DOC], [false])
|
||||||
])
|
])
|
||||||
AM_CONDITIONAL([ENABLE_GTK_DOC_CHECK], [test "x$enable_gtk_doc_check" = xyes])
|
AM_CONDITIONAL([ENABLE_GTK_DOC_CHECK], [test "x$enable_gtk_doc_check" = xyes])
|
||||||
|
|
||||||
|
|
||||||
|
AC_ARG_ENABLE(docbook-docs,
|
||||||
|
[AS_HELP_STRING([--enable-docbook-docs],[build documentation (requires xmlto)])],
|
||||||
|
enable_docbook_docs=$enableval, enable_docbook_docs=auto)
|
||||||
|
AC_PATH_PROG(XMLTO, xmlto, no)
|
||||||
|
AC_MSG_CHECKING([whether to build DocBook documentation])
|
||||||
|
if test x$XMLTO = xno ; then
|
||||||
|
have_docbook=no
|
||||||
|
else
|
||||||
|
have_docbook=yes
|
||||||
|
fi
|
||||||
|
if test x$enable_docbook_docs = xauto ; then
|
||||||
|
if test x$have_docbook = xno ; then
|
||||||
|
enable_docbook_docs=no
|
||||||
|
else
|
||||||
|
enable_docbook_docs=yes
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
if test x$enable_docbook_docs = xyes; then
|
||||||
|
if test x$have_docbook = xno; then
|
||||||
|
AC_MSG_ERROR([Building DocBook docs explicitly required, but DocBook not found])
|
||||||
|
fi
|
||||||
|
AC_MSG_RESULT(yes)
|
||||||
|
else
|
||||||
|
AC_MSG_RESULT(no)
|
||||||
|
fi
|
||||||
|
AM_CONDITIONAL(DOCBOOK_DOCS_ENABLED, test x$enable_docbook_docs = xyes)
|
||||||
|
AC_ARG_VAR([XMLTO],[Define/override the 'xmlto' location.])
|
||||||
|
AC_ARG_VAR([XMLTO_FLAGS],[Define/override 'xmlto' options, like '--skip-validation'.])
|
||||||
|
|
||||||
|
|
||||||
##################################################
|
##################################################
|
||||||
# Visibility handling
|
# Visibility handling
|
||||||
##################################################
|
##################################################
|
||||||
|
@ -391,6 +422,7 @@ doc/reference/Makefile
|
||||||
flatpak.pc
|
flatpak.pc
|
||||||
lib/flatpak-version-macros.h
|
lib/flatpak-version-macros.h
|
||||||
doc/reference/version.xml
|
doc/reference/version.xml
|
||||||
|
doc/flatpak-docs.xml
|
||||||
po/Makefile.in
|
po/Makefile.in
|
||||||
])
|
])
|
||||||
AC_OUTPUT
|
AC_OUTPUT
|
||||||
|
|
|
@ -51,6 +51,27 @@ man_MANS = \
|
||||||
|
|
||||||
xml_files = $(man_MANS:.1=.xml)
|
xml_files = $(man_MANS:.1=.xml)
|
||||||
|
|
||||||
EXTRA_DIST = $(xml_files)
|
EXTRA_DIST = \
|
||||||
|
$(xml_files) \
|
||||||
|
docbook.css \
|
||||||
|
flatpak-docs.xml.in \
|
||||||
|
xmlto-config.xsl \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
|
DISTCLEANFILES = \
|
||||||
|
$(man_MANS) \
|
||||||
|
flatpak-docs.xml \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
|
if DOCBOOK_DOCS_ENABLED
|
||||||
|
|
||||||
|
doc_DATA = \
|
||||||
|
flatpak-docs.html \
|
||||||
|
docbook.css \
|
||||||
|
$(NULL)
|
||||||
|
|
||||||
|
flatpak-docs.html: flatpak-docs.xml $(xml_files) xmlto-config.xsl
|
||||||
|
$(AM_V_GEN) $(XMLTO) $(XMLTO_FLAGS) --skip-validation xhtml-nochunks -m $(srcdir)/xmlto-config.xsl $<
|
||||||
|
|
||||||
|
endif # DOCBOOK_DOCS_ENABLED
|
||||||
|
|
||||||
DISTCLEANFILES = $(man_MANS)
|
|
||||||
|
|
|
@ -0,0 +1,78 @@
|
||||||
|
body
|
||||||
|
{
|
||||||
|
font-family: sans-serif;
|
||||||
|
}
|
||||||
|
h1.title
|
||||||
|
{
|
||||||
|
}
|
||||||
|
.permission
|
||||||
|
{
|
||||||
|
color: #ee0000;
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
.synopsis, .classsynopsis
|
||||||
|
{
|
||||||
|
background: #eeeeee;
|
||||||
|
border: solid 1px #aaaaaa;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
.programlisting
|
||||||
|
{
|
||||||
|
background: #eeeeff;
|
||||||
|
border: solid 1px #aaaaff;
|
||||||
|
padding: 0.5em;
|
||||||
|
}
|
||||||
|
.variablelist
|
||||||
|
{
|
||||||
|
padding: 4px;
|
||||||
|
margin-left: 3em;
|
||||||
|
}
|
||||||
|
.variablelist td:first-child
|
||||||
|
{
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
td.shortcuts
|
||||||
|
{
|
||||||
|
color: #770000;
|
||||||
|
font-size: 80%;
|
||||||
|
}
|
||||||
|
div.refnamediv
|
||||||
|
{
|
||||||
|
margin-top: 2em;
|
||||||
|
}
|
||||||
|
div.toc
|
||||||
|
{
|
||||||
|
border: 2em;
|
||||||
|
}
|
||||||
|
a
|
||||||
|
{
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
a:hover
|
||||||
|
{
|
||||||
|
text-decoration: underline;
|
||||||
|
color: #FF0000;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.table table
|
||||||
|
{
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0px;
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #777777;
|
||||||
|
border-width: 1px;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.table table td, div.table table th
|
||||||
|
{
|
||||||
|
border-style: solid;
|
||||||
|
border-color: #777777;
|
||||||
|
border-width: 1px;
|
||||||
|
padding: 3px;
|
||||||
|
vertical-align: top;
|
||||||
|
}
|
||||||
|
|
||||||
|
div.table table th
|
||||||
|
{
|
||||||
|
background-color: #eeeeee;
|
||||||
|
}
|
|
@ -0,0 +1,44 @@
|
||||||
|
<?xml version="1.0"?>
|
||||||
|
<!DOCTYPE reference 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'">
|
||||||
|
]>
|
||||||
|
<reference xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||||
|
<referenceinfo>
|
||||||
|
<releaseinfo>Version @VERSION@</releaseinfo>
|
||||||
|
</referenceinfo>
|
||||||
|
<title>Flatpak Command Reference</title>
|
||||||
|
<partintro>
|
||||||
|
<para>
|
||||||
|
Flatpak comes with a rich commandline interface.
|
||||||
|
</para>
|
||||||
|
</partintro>
|
||||||
|
<xi:include href="flatpak-install.xml"/>
|
||||||
|
<xi:include href="flatpak-update.xml"/>
|
||||||
|
<xi:include href="flatpak-uninstall.xml"/>
|
||||||
|
<xi:include href="flatpak-list.xml"/>
|
||||||
|
<xi:include href="flatpak-info.xml"/>
|
||||||
|
<xi:include href="flatpak-run.xml"/>
|
||||||
|
<xi:include href="flatpak-override.xml"/>
|
||||||
|
<xi:include href="flatpak-enter.xml"/>
|
||||||
|
<xi:include href="flatpak-document-export.xml"/>
|
||||||
|
<xi:include href="flatpak-document-unexport.xml"/>
|
||||||
|
<xi:include href="flatpak-document-info.xml"/>
|
||||||
|
<xi:include href="flatpak-document-list.xml"/>
|
||||||
|
<xi:include href="flatpak-remote-add.xml"/>
|
||||||
|
<xi:include href="flatpak-remote-modify.xml"/>
|
||||||
|
<xi:include href="flatpak-remote-delete.xml"/>
|
||||||
|
<xi:include href="flatpak-remote-list.xml"/>
|
||||||
|
<xi:include href="flatpak-remote-ls.xml"/>
|
||||||
|
<xi:include href="flatpak-build-init.xml"/>
|
||||||
|
<xi:include href="flatpak-build.xml"/>
|
||||||
|
<xi:include href="flatpak-build-finish.xml"/>
|
||||||
|
<xi:include href="flatpak-build-export.xml"/>
|
||||||
|
<xi:include href="flatpak-build-bundle.xml"/>
|
||||||
|
<xi:include href="flatpak-build-import-bundle.xml"/>
|
||||||
|
<xi:include href="flatpak-build-update-repo.xml"/>
|
||||||
|
<xi:include href="flatpak-build-sign.xml"/>
|
||||||
|
<xi:include href="flatpak-builder.xml"/>
|
||||||
|
<xi:include href="flatpak-metadata.xml"/>
|
||||||
|
<xi:include href="flatpak-make-current.xml"/>
|
||||||
|
</reference>
|
|
@ -0,0 +1,6 @@
|
||||||
|
<?xml version='1.0'?>
|
||||||
|
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||||
|
xmlns:fo="http://www.w3.org/1999/XSL/Format"
|
||||||
|
version="1.0">
|
||||||
|
<xsl:param name="html.stylesheet" select="'docbook.css'"/>
|
||||||
|
</xsl:stylesheet>
|
Loading…
Reference in New Issue