Skip to content

Add bibliography#340

Open
MeikeWeiss wants to merge 4 commits intogap-packages:masterfrom
MeikeWeiss:meike/bib
Open

Add bibliography#340
MeikeWeiss wants to merge 4 commits intogap-packages:masterfrom
MeikeWeiss:meike/bib

Conversation

@MeikeWeiss
Copy link
Copy Markdown
Collaborator

Not finished yet

@MeikeWeiss MeikeWeiss linked an issue Aug 28, 2025 that may be closed by this pull request
Comment thread makedoc.g Outdated
AutoDoc( rec( scaffold := rec(
MainPage := false),
MainPage := false,
bib := "SimplicialSurfaces"),
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has no effect because of MainPage := false.

You need to edit your mainfile (which is doc/SimplicialSurfaces.xml) and insert at the end <Bibliography Databases="SimplicialSurfaces" /> (just before <TheIndex/>)

Comment thread makedoc.g
autodoc := rec(
autodoc := rec(
files := [ ],
scan_dirs := ["doc", "gap", "gap/PolygonalComplexes", "gap/Paths", "gap/Library", "gap/ColouredComplexes", "gap/Flags", "gap/Morphisms"]),
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latest AutoDoc 2026.03.17 (to be shipped with GAP 4.16.0) scans dirs recursively, so this then can be simplified to

Suggested change
scan_dirs := ["doc", "gap", "gap/PolygonalComplexes", "gap/Paths", "gap/Library", "gap/ColouredComplexes", "gap/Flags", "gap/Morphisms"]),
scan_dirs := ["doc", "gap"]),

But of course it's best to keep this for now because most likely you are using an older AutoDoc on your computer ;-). If such a change was made then the version check at the top of this file should enforce that AutoDoc 2026.03.17 or newer is used

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the comment! Good to know for the future:)

@codecov
Copy link
Copy Markdown

codecov Bot commented May 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.53%. Comparing base (3524247) to head (b136aca).
⚠️ Report is 55 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #340      +/-   ##
==========================================
+ Coverage   70.58%   73.53%   +2.95%     
==========================================
  Files          62       61       -1     
  Lines       17269    17551     +282     
==========================================
+ Hits        12190    12907     +717     
+ Misses       5079     4644     -435     
Files with missing lines Coverage Δ
gap/ColouredComplexes/variColouring.gd 100.00% <ø> (ø)
gap/PolygonalComplexes/constructing_families.gd 100.00% <ø> (ø)
gap/PolygonalComplexes/modification.gd 100.00% <ø> (ø)

... and 17 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MeikeWeiss MeikeWeiss requested review from aniemeyer May 6, 2026 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a bibliography to the manual?

2 participants