reactos/ninja
1
0
Fork 0
mirror of https://github.com/reactos/ninja.git synced 2024-11-26 21:20:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
a33b813058
ninja/doc
History
Dimitris Apostolou 6c5e886aac Fix typos
2020-07-07 13:00:22 +02:00
..
dblatex.xsl improve docs generation, including PDF output 2015-11-17 14:05:53 -08:00
docbook.xsl Docs: Make builds reproducible by generating the same IDs from the same inputs 2019-02-07 17:33:59 -05:00
doxygen.config move various doc files out of top-level directory 2011-05-14 16:11:41 -07:00
manual.asciidoc Fix typos 2020-07-07 13:00:22 +02:00
README.md improve docs generation, including PDF output 2015-11-17 14:05:53 -08:00
style.css use the default font size for manual headings 2015-12-16 08:48:59 -08:00

README.md

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.