Switch makedoc.g to using AutoDoc - #53
Open
fingolfin wants to merge 1 commit into
Open
Conversation
The hand written ExtractMyManualExamples in makedoc.g produced test files
which did not actually pass when running the test suite. Use AutoDoc for
extracting the examples instead, as it is done in several other packages
by now.
The version data entities move from a GAPDoc block in PackageInfo.g into
the AutoDoc entities record, together with the entities for the other
packages referred to by the manual; from these AutoDoc generates
doc/_entities.xml. The entity for SCSCP itself is added by AutoDoc.
AutoDoc numbers the generated test files consecutively, while the old
code used the chapter number, so tst/scscp0{4,...,9}.tst become
tst/scscp0{1,...,6}.tst. Adjust the list of files to exclude in
tst/testall.g accordingly, as those names are hardcoded there.
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 #53 +/- ##
=======================================
Coverage 69.53% 69.53%
=======================================
Files 24 24
Lines 2669 2669
=======================================
Hits 1856 1856
Misses 813 813 🚀 New features to boost your workflow:
|
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.
The hand written ExtractMyManualExamples in makedoc.g produced test files
which did not actually pass when running the test suite. Use AutoDoc for
extracting the examples instead, as it is done in several other packages
by now.
The version data entities move from a GAPDoc block in PackageInfo.g into
the AutoDoc entities record, together with the entities for the other
packages referred to by the manual; from these AutoDoc generates
doc/_entities.xml. The entity for SCSCP itself is added by AutoDoc.
AutoDoc numbers the generated test files consecutively, while the old
code used the chapter number, so tst/scscp0{4,...,9}.tst become
tst/scscp0{1,...,6}.tst. Adjust the list of files to exclude in
tst/testall.g accordingly, as those names are hardcoded there.
Co-Authored-By: Claude Opus 5 noreply@anthropic.com