Skip to content

Use AutoDoc to build manual #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fingolfin merged 1 commit into from
May 27, 2026
Merged

Use AutoDoc to build manual #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions PackageInfo.g
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Subtitle := "Integration of mpfr, mpfi, mpc, fplll and cxsc in GAP",
Version := "1.0.9",
Date := "26/08/2025", # dd/mm/yyyy format
License := "GPL-2.0-or-later",
## <#GAPDoc Label="Version">
## <!ENTITY Version "1.0.9">
## <!ENTITY Date "26/08/2025">
## <#/GAPDoc>
Persons := [
rec(
LastName := "Bartholdi",
Expand Down Expand Up @@ -109,5 +105,15 @@ BannerFunction := function(info)
end,

TestFile := "tst/testall.g",
Keywords := ["floating-point"]
Keywords := ["floating-point"],

AutoDoc := rec(
entities := rec(
Version := ~.Version,
Date := ~.Date,
),
MainPage := false,
TitlePage := false,
),

));
2 changes: 1 addition & 1 deletion doc/float.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<!DOCTYPE Book SYSTEM "gapdoc.dtd" [
<!ENTITY see '<Alt Only="LaTeX">$\to$</Alt><Alt Not="LaTeX">--&tgt;</Alt>'>
<#Include Label="Version">
<#Include SYSTEM "_entities.xml">
]>
<Book Name="FLOAT">

Expand Down
20 changes: 9 additions & 11 deletions makedoc.g
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
#if fail = LoadPackage("AutoDoc", ">= 2016.01.21") then
# Error("AutoDoc 2016.01.21 or newer is required");
#fi;
#AutoDoc(rec(gapdoc := rec(files:=["PackageInfo.g"])));

MakeGAPDocDoc("doc","float",
["../lib/float.gd","../lib/pslq.gi","../PackageInfo.g"],"float","MathJax");
CopyHTMLStyleFiles("doc");
GAPDocManualLab("Float");

QUIT;
if fail = LoadPackage("AutoDoc", ">= 2022.07.10") then
Error("AutoDoc 2022.07.10 or newer is required");
fi;
AutoDoc(rec(
gapdoc := rec(
main:="float.xml",
LaTeXOptions := rec( InputEncoding := "latin1" ),
)
));