Convert documentation to GAPDoc/AutoDoc - #61
Open
fingolfin wants to merge 5 commits into
Open
Conversation
The manual examples now come from doc/*.xml via AutoDoc, so tst/manual.tst and doc/make_mantest, which generated it, are gone. The bibliography was only ever a hand-written manual.bbl; it is now doc/manual.bib. Also fixes two errors the conversion exposed: the dispatcher block was declared as SpaceGroupTypesByPointGroupOnLeft rather than SpaceGroupTypesByPointGroup, giving a duplicate label, and the \^ method for AffineCrystGroup had no parsable declaration. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
fingolfin
force-pushed
the
mh/convert-doc-to-gapdoc
branch
from
August 16, 2026 17:53
8ec1647 to
3650cab
Compare
The examples using NormalizerInGLnZ failed in onlyneeded mode, where CaratInterface is not loaded. They are now Log blocks, which AutoDoc does not extract; tst/cryst.tst checks them when CaratInterface is present, as tst/manual.tst used to. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #61 +/- ##
=======================================
Coverage 94.68% 94.68%
=======================================
Files 24 24
Lines 7524 7524
=======================================
Hits 7124 7124
Misses 400 400 🚀 New features to boost your workflow:
|
make_tar still called doc/make_doc, shipped the plain-TeX output and an htm/ directory that no longer exists. doc/manual.tex is no longer a place the version has to be edited: AutoDoc takes it from PackageInfo.g.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Also fixes two errors the conversion exposed: the dispatcher block was declared as
SpaceGroupTypesByPointGroupOnLeftrather thanSpaceGroupTypesByPointGroup, giving a duplicate label, and the ^ method forAffineCrystGrouphad no parsable declaration.Also fixes minor errors in the manual and README.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com