Commit Graph

7 Commits

Author SHA1 Message Date
Glen Whitney 1ceccc84c7 Use experimental AutoDoc feature follow_package
Change doc/makedoc.g so that AutoDoc will read the code in roughly the
same order GAP processes it, leading to a more natural order for the
documentation.
2018-09-02 11:36:14 -04:00
Glen Whitney e9e38ec41c Extend coverage of documentation to lib/structure.g[di] 2018-09-01 23:51:58 -04:00
Glen Whitney 82c69a16a9 Make first pass at full doc coverage for structure.g[di]
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
2018-09-01 11:12:31 -04:00
Glen Whitney 0cef163077 Incorporate the tests generated by AutoDoc into tst/testall.g 2018-08-21 13:05:02 -07:00
Glen Whitney 31773603de Add AutoDoc record to PackageInfo and use entities for packages 2018-08-21 12:33:38 -07:00
Glen Whitney b5207d0067 Move makedoc.g to doc/ subdirectory 2018-08-21 11:29:13 -07:00
Glen Whitney be82518697 Organize raq into standard GAP package file tree
In preparation for a beta release of the raq package, it's important for it to
be conformant to current GAP package conventions. Therefore, I have rearranged
the file tree to match the Example package quite thoroughly. In so doing, this
laid the foundation for the following aspects of the package:

  - Package documentation. Added makedoc.g at the top level to generate
  AutoDoc/GAPDoc documentation for raq. Currently the documentation is empty;
  future development will bring the documentation to cover all existing code.

  - Package tests. The basic structure to add .tst files in the tst
  subdirectory of the package is in place. The coverage of tests provided in
  this commit is minimal; again, further development will extend the test
  coverage.

In addition, PackageInfo.g has been elaborated to include much more complete
information about raq and where it will (initially) be posted on line.

Resolves: #1
2018-08-16 21:12:38 -07:00