Commit Graph

20 Commits

Author SHA1 Message Date
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 5f41ae5bbf Try a version of README dependent on an experimental AutoDoc 2018-08-21 00:38:28 -07:00
Glen Whitney 4fac5682b8 Forget link markdown since gitea doesn't seem to respect it 2018-08-19 10:44:57 -07:00
Glen Whitney 14cb4024cb Use proper link markdown in README 2018-08-19 10:39:31 -07:00
Glen Whitney 766e0d4d36 Use proper code fence in README 2018-08-19 10:33:07 -07:00
Glen Whitney e396d06953 Try again to fix the README for the web 2018-08-19 10:31:32 -07:00
Glen Whitney d0303b88a6 Compromise on the README until resolution of AutoDoc issues 2018-08-19 10:22:19 -07:00
Glen Whitney 6f367fc14c Try a fourth way to get preformmatted text in README 2018-08-19 00:24:35 -07:00
Glen Whitney c96b696a50 Try a third way to get a code fence in README 2018-08-19 00:02:21 -07:00
Glen Whitney 461ebd756d Try a different way to get a code fence in README 2018-08-18 23:59:58 -07:00
Glen Whitney bb3f63cab2 Fix some incorrect HTML comment opens in README.md 2018-08-18 23:52:42 -07:00
Glen Whitney 44c71ef05f Use README.md for manual intro (initial working version) 2018-08-18 23:48:21 -07:00
Glen Whitney 443affd1f8 Use the README for intro manual material (try 1) 2018-08-18 22:34:13 -07:00
Glen Whitney 7d8684d859 Fix typo in README 2018-08-18 11:00:50 -07:00
Glen Whitney ffb88b99e8 Standardize on RAQ as the name of this package 2018-08-18 10:58:08 -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
Glen Whitney a50286f959 Initial commit 2018-08-01 04:35:36 +00:00