Skip to content
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

Merged
merged 30 commits into from
Feb 12, 2020
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
ce836e2
convert Changes part of manual into markdown
dimpase Feb 5, 2020
0597e51
an attempt to get an anchor
dimpase Feb 6, 2020
c131923
removed chap*.md part from anchor names
dimpase Feb 6, 2020
b121dcd
added GAP 4.11 notes from wiki
dimpase Feb 6, 2020
75c4d7f
fixed anchors
dimpase Feb 6, 2020
13a995a
fixed some misleading copypastes
dimpase Feb 6, 2020
3b6bf55
fixed header dates/version, added self-reference
dimpase Feb 6, 2020
bf1c071
Remove more references to 'changes' manual
fingolfin Feb 6, 2020
85c261d
changes.md: **GAP** -> GAP
fingolfin Feb 6, 2020
7bdb420
Simplify PR links
fingolfin Feb 6, 2020
e6ea3a9
Drop most of the pointless section numbers
fingolfin Feb 6, 2020
5c72952
Remove useless preamble
fingolfin Feb 6, 2020
bc8134f
got rid of links to "changes" book in the manual
dimpase Feb 6, 2020
00e9295
moved and renamed to CHANGES.md
dimpase Feb 6, 2020
886e4e2
"Changes" were also present, not only "changes"
dimpase Feb 6, 2020
1c6ddd3
remove more mentions of the Manual Book of Changes
dimpase Feb 7, 2020
7828baa
added release date, changed heading
dimpase Feb 7, 2020
139cc6b
CHANGES.md: align section headlines
fingolfin Feb 7, 2020
1bdb16d
reorder CHANGES.md entries
fingolfin Feb 7, 2020
357b0ea
moar
fingolfin Feb 7, 2020
2458503
yet more
fingolfin Feb 7, 2020
c8a2f75
more
fingolfin Feb 7, 2020
c26729c
more
fingolfin Feb 7, 2020
7c9125e
markdowned most "naked" URLs
dimpase Feb 8, 2020
fe8c470
fixed the remaining "naked" URLs, removed some TeX's '\'
dimpase Feb 8, 2020
19721d7
mention HPC-GAP manual at appropriate places
dimpase Feb 11, 2020
737c467
added Labels, corrected wrong bookname
dimpase Feb 11, 2020
d865442
get rid of GAPDoc version
dimpase Feb 12, 2020
b5ccc4d
some more reformatting, links
fingolfin Feb 12, 2020
4be5663
hpc
fingolfin Feb 12, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -399,8 +399,7 @@ 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) and `ref` (the reference manual).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and hpc


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
6,303 changes: 6,303 additions & 0 deletions doc/Changes.md

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions doc/README.md
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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Member

Choose a reason for hiding this comment

The 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
Expand All @@ -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.
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