diff options
| author | David 'Digit' Turner <digit+github@google.com> | 2024-01-11 19:00:09 (GMT) |
|---|---|---|
| committer | David 'Digit' Turner <digit+github@google.com> | 2024-02-13 13:46:06 (GMT) |
| commit | ccf2339f4ab7b90b2d5bf1b6668250876aebea5c (patch) | |
| tree | 29ff235718b987ded74fc347aec1aebbbd79a961 | |
| parent | fd7067652cae480190bf13b2ee5475efdf09ac7d (diff) | |
| download | Ninja-ccf2339f4ab7b90b2d5bf1b6668250876aebea5c.zip Ninja-ccf2339f4ab7b90b2d5bf1b6668250876aebea5c.tar.gz Ninja-ccf2339f4ab7b90b2d5bf1b6668250876aebea5c.tar.bz2 | |
README.md: document Manual and Doxygen generation
Fixes #2362
| -rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
@@ -49,3 +49,39 @@ To run the unit tests: ``` ./build-cmake/ninja_test ``` + +## Generating documentation + +### Ninja Manual + +You must have `asciidoc` and `xsltproc` in your PATH, then do: + +``` +./configure.py +ninja manual doc/manual.pdf +``` + +Which will generate `doc/manual.html`. + +To generate the PDF version of the manual, you must have `dblatext` in your PATH then do: + +``` +./configure.py # only if you didn't do it previously. +ninja doc/manual.pdf +``` + +Which will generate `doc/manual.pdf`. + +### Doxygen documentation + +If you have `doxygen` installed, you can build documentation extracted from C++ +declarations and comments to help you navigate the code. Note that Ninja is a standalone +executable, not a library, so there is no public API, all details exposed here are +internal. + +``` +./configure.py # if needed +ninja doxygen +``` + +Then open `doc/doxygen/html/index.html` in a browser to look at it. |