Skip to content

Commit

Permalink
convert Changes manual book into markdown, add GAP 4.11 release notes
Browse files Browse the repository at this point in the history
Squash and merge PR #3886:
- convert Changes manual into a single markdown file
- add GAP 4.11 release notes
Co-authored by Dima Pasechnik and Max Horn
  • Loading branch information
dimpase authored and Alexander Konovalov committed Feb 12, 2020
1 parent aa0ba38 commit c6e2bac
Show file tree
Hide file tree
Showing 26 changed files with 5,988 additions and 8,472 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Thank You!

If this pull request should be mentioned in the release notes,
please provide a short description matching the style of the GAP
[Changes manual](https://www.gap-system.org/Manuals/doc/changes/chap0.html).
`CHANGES.md` file in the root directory.

## Further details

Expand Down
5,947 changes: 5,947 additions & 0 deletions CHANGES.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,8 +401,8 @@ GAP Reference manual.

The manual is also available in pdf format. In the full distribution these
files are included in the directory `gap-4.X.Y/doc` in the subdirectories
`tut` (a beginner's tutorial), `ref` (the reference manual) and `changes`
(changes from earlier versions).
`tut` (a beginner's tutorial), `ref` (the reference manual), and `hpc` (HPC-GAP
reference manual).

If you want to use these manual files with the help system from your GAP
session you may check (or make sure) that your system provides some
Expand Down
14 changes: 8 additions & 6 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
GAP has three main GAP manuals (they are called "main" to distinguish them from package
GAP has three main GAP manuals (they are called "main" to distinguish them from package
manuals that are maintained by the authors of the respective packages):
* **GAP Tutorial**
* **GAP Reference Manual**
* **Changes from Earlier Versions**
* **HPC-GAP Reference Manual**

These manuals are written in GAPDoc format, provided by the
[GAPDoc package](http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/index.html).
Their source is contained in the directories `doc/tut`, `doc/ref` and `doc/changes`
Their source is contained in the directories `doc/tut`, `doc/ref` and `doc/hpc`
respectively. Some documentation is also stored in the library files to be kept
close to the code it describes. It is included in the manual using the mechanism
documented [here](https://www.gap-system.org/Manuals/pkg/GAPDoc-1.5.1/doc/chap4.html).
documented [here](http://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc/doc/chap4.html).

There is also a document describing [**Changes from Earlier Versions**](../CHANGES.md).

The official GAP distribution includes all documentation, so there is no need to
build it after GAP installation. However, if you need to build the development
Expand All @@ -21,10 +23,10 @@ steps:
the latest GAP release).
* build manuals by calling `make doc`

This will build all three manuals. Each of them will be built twice to ensure that
This will build the manuals. Each of them will be built twice to ensure that
cross-references between manuals are resolved.

Each of these three directories contains a file `makedocrel.g`. You may read it into
Each of these directories contain a file `makedocrel.g`. You may read it into
GAP if you want to build faster just one manual to see how your changes look like,
or if GAPDoc reports an error in the XML code that you want to debug. Then you may
call `make doc` as a final check at a later stage.
929 changes: 0 additions & 929 deletions doc/changes/changes-4.10.xml

This file was deleted.

188 changes: 0 additions & 188 deletions doc/changes/changes43.xml

This file was deleted.

Loading

0 comments on commit c6e2bac

Please sign in to comment.