This is information for authors about what files they should and should
not edit. Users should find more information in the README file in this
directory or in manual.*, chapInd.html or chapInd.txt in the doc
subdirectory.

Files to edit for documentation:
===============================
The following files can be edited to change the documentation:

- doc/gbnp_doc.xml to edit the manual. This manual also includes:
  + lib/*gi for included function descriptions
  + doc/examples/*g for examples in the manual
  The manual is written in GAPDoc format, see also
  http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/index.html

- TODO (list of some things that could be done)
- lib/OPTIONS (information about some options)
- README_AUTHORS (this file)
- COPYRIGHT (copyright text)

Files that are overwritten automatically: (do not edit)
========================================
- in doc: manual.* chap*
- in tst: gbnpNN.tst

To rebuild the documentation:
=============================
>gap makedoc.g

This also extracts every <Example> in the manual into tst/gbnpNN.tst, which
the test suite runs; commit them together with the documentation change.
Examples must not print timings.

To rerun individual examples:
=============================
To regenerate doc/examples/example07.xml from example07.g (review the diff,
then run makedoc.g):
- cd doc/examples
- ../../etc/gapscript example07
- sed -f txt2xml.sed example07.txt > example07.xml
- rm example07.txt

$GAP sets the GAP command (default: gap).

For a release:
==============
Update the version and date in PackageInfo.g and CHANGES.md, commit, then
run the "Release" workflow (.github/workflows/release.yml) from the
Actions tab on GitHub. It builds the documentation, runs .release and
publishes the release and the website.
