glen/RAQ
1
0
Fork 0
Code Issues 1 Pull requests Releases Wiki Activity

Make first pass at full doc coverage for structure.g[di]

Browse source 
To do this, the structure of the manual needed to be elaborated, which was
accomplished with a skeleton file, doc/chapters.autodoc, which is explicitly
loaded first.

Note that this portion of the manual may still need polishing; in particular,
perhaps it could use more examples, which would then double as tests in
tst/testall.g
This commit is contained in:
Glen Whitney 2018-09-01 11:12:31 -04:00
parent 0cef163077
commit 82c69a16a9
6 changed files with 196 additions and 35 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/chapters.autodoc Normal file
View file

@ -0,0 +1,11 @@
@Chapter construct
@ChapterTitle Constructing One-Sided Quasigroups, Racks, and Quandles.
@Chapter operate
@ChapterTitle Operations on One-Sided Quasigroups, Racks, and Quandles.
@Chapter basic
@ChapterTitle Basic Notions
@Chapter technical
@ChapterTitle Technical Details

2
doc/makedoc.g
View file

@ -3,7 +3,7 @@
LoadPackage("AutoDoc");
AutoDoc(rec(
autodoc := rec(files := ["README.md"]),
autodoc := rec(files := ["README.md", "doc/chapters.autodoc"]),
maketest := rec(name := "tst/AutoDoc_tests.g")
));
QUIT;