doc/docdescr.doc Updating William's explanation of how to build docs,
Sun Nov 30 21:06:29 MST 2003 John Fleck <jfleck@inkstain.net>
* doc/docdescr.doc
Updating William's explanation of how to build docs,
reflecting Daniel's new docs build system
diff --git a/doc/docdescr.doc b/doc/docdescr.doc
index c375f2c..427a1ff 100644
--- a/doc/docdescr.doc
+++ b/doc/docdescr.doc
@@ -49,44 +49,11 @@
Given the above files, the generation of the complete documentation (as
provided on the web by xmlsoft.org) can be created with the following steps:
-NOTE: Steps 1 through 5 are performed with the command "make rebuild";
- Step 6 must be accomplished manually.
- Steps 7 and 8 are performed with the command "make web"
+NOTE: Steps 1 through 7 are performed with the command "make rebuild";
+ Steps 3 and 5 through 7 are performed with the command "make all"
-1) Generate libxml-decl.txt, libxml-decl-list.txt and libxml-sections.txt:
- make scan, or,
- gtkdoc-scan --module=libxml --source-dir=../ \
- --ignore-headers="acconfig.h config.h win32config.h trio.h triostr.h
- triop.h config-m ac.h XMLTestPrefix2.h XMLTestPrefix.h
- triodef.h trionan.h xlink.h libxml.h libx ml2-py.h
- libxml_wrap.h"
- These three files are used by the gdk-doc routines in the following steps.
-
-2) Generate the sgml documentation in the subdirectory "tmpl":
- make templates, or,
- gtkdoc-mktmpl --module=libxml
-
-3) Generate the xml documentation in the subdirectory "xml":
- make xml, or,
- gtkdoc-mkdb --module=libxml --source-dir=../ --output-format=xml \
- --main-sgml-file=gnome-xml.xml
-
- This also generates the file gnome-xml.xml.
- Note that, in order to produce "readable" documentation, the file
- gnome-xml.xml should be manually edited in order to put in appropriate
- titles.
-
-4) Generate the main html documentation in the subdirectory "html":
- make html, or,
- cd html
- gtkdoc-mkhtml libxml ../gnome-xml.xml
- cd ../
-
- Note that the file index.html is really not suitable, so a manual
- substitution of a generic index is done.
-
-5) Generate libxml2-api.xml:
+1) Generate libxml2-api.xml:
./apibuild.py
This script is a more recent addition to the documentation generation.
@@ -96,33 +63,32 @@
from the source comments within these). It produces an xml file which
contains all of this information, "libxml2-api.xml".
-6) Generate libxml2-refs.xml:
+2) Generate libxml2-refs.xml:
./parsedecl.py
- This script uses the *.txt files generated by Step 1, together with the
- files in the subdirectory xml produced in Step 3, and produces the summary
+ This script produces the summary
xml file "libxml2-refs.xml". Historically, it also used to produce
information on the api's in the file "libxml2-api.xml", but that step is
now being done by a separate script.
-7) Generate the site's main pages:
+3) Generate the site's main pages:
xsltproc --nonet --html --output index.html site.xsl xml.html
All of the "top-level" pages (except xmlreader.html and guidelines.html)
which have navigation framing, are generated from this step
-8) Generate the contents and cross-referencing pages:
+4) Generate the contents and cross-referencing pages:
xsltproc --nonet --html api.xsl xml.html
-9) Generate the NEWS file in the top directory:
+5) Generate the NEWS file in the top directory:
xsltproc --nonet --output ../NEWS news.xsl news.html
-10)Generate the XML Software Autoupdate file libxml2.xsa:
+6) Generate the XML Software Autoupdate file libxml2.xsa:
make libxml2.xsa, or,
xsltproc --nonet --output libxml2.xsa xsa.xsl news.html
-11)Manually generate xmlcatalog.1 and xmllint.1 using manpages/docbook.xsl
- stylesheet in docbook stylesheets
+7) Manually generate xmlcatalog.1 and xmllint.1 using manpages/docbook.xsl
+ stylesheet in docbook stylesheets. "make all" also takes care of this.
After these steps have been done, the documentation is complete.
The search engine is then set up using the script index.py, using
@@ -130,5 +96,5 @@
mailing list archives at gnome.org.
-Last update: 15 November 2003
+Last update: 30 November 2003