diff --git a/PackageInfo.g b/PackageInfo.g index 46f2abf..16e28a2 100644 --- a/PackageInfo.g +++ b/PackageInfo.g @@ -1,6 +1,6 @@ ## <#GAPDoc Label="PKGVERSIONDATA"> -## -## +## +## ## <#/GAPDoc> SetPackageInfo(rec( @@ -9,9 +9,9 @@ PackageName := "SgpDec", Subtitle := "Hierarchical Coordinatizations of Finite Groups and Semigroups", -Version := "0.9.8-dev", +Version := "0.9.8", -Date := "01/09/2023", # dd/mm/yyyy format +Date := "13/06/2024", # dd/mm/yyyy format License := "GPL-2.0-or-later", Persons := [ diff --git a/lib/doc.g b/lib/doc.g new file mode 100644 index 0000000..7aafcd2 --- /dev/null +++ b/lib/doc.g @@ -0,0 +1,32 @@ +#temporary solution before using AutoDoc + +SgpDecDocSourceFiles := ["../PackageInfo.g", + "mansections.xml"]; +MakeReadOnlyGVar("SgpDecDocSourceFiles"); + +SgpDecMakeDoc := function() + MakeGAPDocDoc( + Concatenation(PackageInfo("sgpdec")[1]!.InstallationPath,"/doc"), + "main.xml", + SgpDecDocSourceFiles, + "SgpDec", + "MathJax", + "../../.."); +end; + +SgpDecRunManualExamples := function() + #to have the same output + SizeScreen([80]); + #to have no profile info + #SetInfoLevel(LagrangeDecompositionInfoClass,0); + #SetInfoLevel(HolonomyInfoClass,0); + #SetInfoLevel(SkeletonInfoClass,0); + RunExamples( + ExtractExamples( + Concatenation(PackageInfo("sgpdec")[1]!.InstallationPath, + "/doc"), + "main.xml", + SgpDecDocSourceFiles, + "Section"), + rec(width:=80,compareFunction:="uptowhitespace")); +end; diff --git a/makedoc.g b/makedoc.g index 4a09a3c..4a33ee3 100644 --- a/makedoc.g +++ b/makedoc.g @@ -1,33 +1,2 @@ -SgpDecDocSourceFiles := ["../PackageInfo.g", - "mansections.xml"]; -MakeReadOnlyGVar("SgpDecDocSourceFiles"); - -SgpDecMakeDoc := function() - MakeGAPDocDoc( - Concatenation(PackageInfo("sgpdec")[1]!.InstallationPath,"/doc"), - "main.xml", - SgpDecDocSourceFiles, - "SgpDec", - "MathJax", - "../../.."); -end; - -SgpDecRunManualExamples := function() - #to have the same output - SizeScreen([80]); - #to have no profile info - #SetInfoLevel(LagrangeDecompositionInfoClass,0); - #SetInfoLevel(HolonomyInfoClass,0); - #SetInfoLevel(SkeletonInfoClass,0); - RunExamples( - ExtractExamples( - Concatenation(PackageInfo("sgpdec")[1]!.InstallationPath, - "/doc"), - "main.xml", - SgpDecDocSourceFiles, - "Section"), - rec(width:=80,compareFunction:="uptowhitespace")); -end; - -#the actual call -SgpDecMakeDoc(); \ No newline at end of file +LoadPackage("sgpdec"); +SgpDecMakeDoc(); diff --git a/read.g b/read.g index bf8b786..709baa5 100644 --- a/read.g +++ b/read.g @@ -1,6 +1,6 @@ # read Implementation files -ReadPackage("SgpDec","/makedoc.g"); +ReadPackage("SgpDec","/lib/doc.g"); ReadPackage("SgpDec","/lib/disjointuniongroups.gi"); ReadPackage("SgpDec","/lib/finiteset.gi");