mirror of
https://github.com/brl/mutter.git
synced 2024-11-22 08:00:42 -05:00
[docs] Rework the API reference version generation
Clutter copies the gtk-doc from the usual gtk+ template, and has a version.xml.in containing only: @VERSION@ Without a newline at the end. Unfortunately, it appears that autoconf has started adding a newline to the generated version.xml which then is used as the payload for the "version" XML entity. Instead of using a secondary file we can make configure generate the whole clutter-docs.xml and cogl-docs.xml files from a template; this way we also get the ability to substitute more autoconf variables into the documentation -- if needs be.
This commit is contained in:
parent
61deeafa71
commit
ffd5fb172b
4
.gitignore
vendored
4
.gitignore
vendored
@ -39,12 +39,12 @@ doc/reference/clutter/clutter-*.txt
|
||||
doc/reference/clutter/html
|
||||
doc/reference/clutter/tmpl
|
||||
doc/reference/clutter/xml
|
||||
doc/reference/clutter/version.xml
|
||||
doc/reference/clutter/clutter.args
|
||||
doc/reference/clutter/clutter.hierarchy
|
||||
doc/reference/clutter/clutter.interfaces
|
||||
doc/reference/clutter/clutter.prerequisites
|
||||
doc/reference/clutter/clutter.signals
|
||||
doc/reference/clutter/clutter-docs.xml
|
||||
doc/reference/clutter/*.stamp
|
||||
doc/reference/clutter/*.bak
|
||||
doc/reference/cogl/cogl-*.txt
|
||||
@ -52,12 +52,12 @@ doc/reference/cogl/cogl-*.txt
|
||||
doc/reference/cogl/html
|
||||
doc/reference/cogl/tmpl
|
||||
doc/reference/cogl/xml
|
||||
doc/reference/cogl/version.xml
|
||||
doc/reference/cogl/cogl.args
|
||||
doc/reference/cogl/cogl.hierarchy
|
||||
doc/reference/cogl/cogl.interfaces
|
||||
doc/reference/cogl/cogl.prerequisites
|
||||
doc/reference/cogl/cogl.signals
|
||||
doc/reference/cogl/cogl-docs.xml
|
||||
doc/reference/cogl/*.stamp
|
||||
doc/reference/cogl/*.bak
|
||||
doltcompile
|
||||
|
@ -741,9 +741,9 @@ AC_CONFIG_FILES([
|
||||
doc/Makefile
|
||||
doc/reference/Makefile
|
||||
doc/reference/clutter/Makefile
|
||||
doc/reference/clutter/version.xml
|
||||
doc/reference/clutter/clutter-docs.xml
|
||||
doc/reference/cogl/Makefile
|
||||
doc/reference/cogl/version.xml
|
||||
doc/reference/cogl/cogl-docs.xml
|
||||
doc/manual/clutter-manual.xml
|
||||
doc/manual/Makefile
|
||||
po/Makefile.in
|
||||
|
@ -113,7 +113,6 @@ 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= \
|
||||
version.xml \
|
||||
subclassing-ClutterActor.xml \
|
||||
clutter-animation-tutorial.xml \
|
||||
creating-behaviours.xml \
|
||||
@ -147,7 +146,6 @@ include $(top_srcdir)/gtk-doc.make
|
||||
# Other files to distribute
|
||||
# e.g. EXTRA_DIST += version.xml.in
|
||||
EXTRA_DIST += \
|
||||
version.xml.in \
|
||||
actor-box.png \
|
||||
easing-modes.png \
|
||||
easing-modes.svg \
|
||||
|
@ -1,7 +1,7 @@
|
||||
<?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" [
|
||||
<!ENTITY version SYSTEM "version.xml">
|
||||
<!ENTITY version "@VERSION@">
|
||||
]>
|
||||
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
@ -1 +0,0 @@
|
||||
@CLUTTER_VERSION@
|
@ -71,7 +71,6 @@ 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 = \
|
||||
version.xml \
|
||||
blend-strings.xml
|
||||
|
||||
# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded
|
||||
@ -94,4 +93,3 @@ include $(top_srcdir)/gtk-doc.make
|
||||
|
||||
# Other files to distribute
|
||||
# e.g. EXTRA_DIST += version.xml.in
|
||||
EXTRA_DIST += version.xml.in
|
||||
|
@ -1,7 +1,7 @@
|
||||
<?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" [
|
||||
<!ENTITY version SYSTEM "version.xml">
|
||||
<!ENTITY version "@VERSION@">
|
||||
]>
|
||||
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
|
||||
|
@ -1 +0,0 @@
|
||||
@CLUTTER_VERSION@
|
Loading…
Reference in New Issue
Block a user