-
Notifications
You must be signed in to change notification settings - Fork 164
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
convert Changes manuals book into markdown #3886
Changes from 12 commits
ce836e2
0597e51
c131923
b121dcd
75c4d7f
13a995a
3b6bf55
bf1c071
85c261d
7bdb420
e6ea3a9
5c72952
bc8134f
00e9295
886e4e2
1c6ddd3
7828baa
139cc6b
1bdb16d
357b0ea
2458503
c8a2f75
c26729c
7c9125e
fe8c470
19721d7
737c467
d865442
b5ccc4d
4be5663
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,16 @@ | ||
GAP has three main GAP manuals (they are called "main" to distinguish them from package | ||
GAP has two main GAP manuals (they are called "main" to distinguish them from package | ||
dimpase marked this conversation as resolved.
Show resolved
Hide resolved
|
||
manuals that are maintained by the authors of the respective packages): | ||
* **GAP Tutorial** | ||
* **GAP Reference Manual** | ||
* **Changes from Earlier Versions** | ||
|
||
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` and `doc/ref` | ||
fingolfin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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](https://www.gap-system.org/Manuals/pkg/GAPDoc-1.6.2/doc/chap4.html). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Replace by more stable http://www.math.rwth-aachen.de/~Frank.Luebeck/gap/GAPDoc/doc/chap4.htm There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. done There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. could be done separately, but why not now? |
||
|
||
There is also a document describing [**Changes from Earlier Versions**](Changes.md). | ||
fingolfin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
|
@@ -21,10 +22,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 | ||
Both of these directories contain a file `makedocrel.g`. You may read it into | ||
dimpase marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. |
This file was deleted.
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and
hpc