[MathJax on]

4 Maintaining the GAP documentation

This chapter explains shortly how the GAP documentation is organized and how to produce the viewable documents from the sources.

4.1 The source of the GAP documentation

Mention that manual examples should fit in 72 character width, and that examples should run as shown if all examples within a chapter are run in a fresh GAP in default configuration with ScreenSize([72]);.

4.2 How to compile the GAP manuals from the sources

To compile the GAP manuals from sources, call

make doc

in the GAP root directory. This will compile each of the three main GAP manuals twice to ensure that cross-references are resolved.

If you need to compile a single manual book, call

gap makedocrel.g

in the corresponding directory (ref, tut, hpc or dev). This is convenient when you're working on the documentation and want to check if the changed manual book compiles, so you need not to recompile all manual books from scratch.

generated by GAPDoc2HTML