summaryrefslogtreecommitdiffstats
path: root/doc/README.md
diff options
context:
space:
mode:
authorEvan Martin <martine@danga.com>2015-11-17 22:04:50 (GMT)
committerEvan Martin <martine@danga.com>2015-11-17 22:05:53 (GMT)
commita6859ac8af7377b1a1e136a6b296f8e8ca950507 (patch)
treec80140188229269ead4b6f033ad6a42090a00c57 /doc/README.md
parent274db07276106944f63a3387bc3826e2211da154 (diff)
downloadNinja-a6859ac8af7377b1a1e136a6b296f8e8ca950507.zip
Ninja-a6859ac8af7377b1a1e136a6b296f8e8ca950507.tar.gz
Ninja-a6859ac8af7377b1a1e136a6b296f8e8ca950507.tar.bz2
improve docs generation, including PDF output
- Fix the manual build rules (missing the .xsl as an input). - Add a README describing how the docs build works. - Add rules that generate PDF, just 'cause we can.
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..6afe5d4
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,11 @@
+This directory contains the Ninja manual and support files used in
+building it. Here's a brief overview of how it works.
+
+The source text, `manual.asciidoc`, is written in the AsciiDoc format.
+AsciiDoc can generate HTML but it doesn't look great; instead, we use
+AsciiDoc to generate the Docbook XML format and then provide our own
+Docbook XSL tweaks to produce HTML from that.
+
+In theory using AsciiDoc and DocBook allows us to produce nice PDF
+documentation etc. In reality it's not clear anyone wants that, but the
+build rules are in place to generate it if you install dblatex.