Skip to content

Commit

Permalink
temporary solution for doc generation, preparing release
Browse files Browse the repository at this point in the history
  • Loading branch information
egri-nagy committed Jun 13, 2024
1 parent 62bed09 commit c398024
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 38 deletions.
8 changes: 4 additions & 4 deletions PackageInfo.g
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## <#GAPDoc Label="PKGVERSIONDATA">
## <!ENTITY VERSION "0.9.8-dev">
## <!ENTITY COPYRIGHTYEARS "2008-2023">
## <!ENTITY VERSION "0.9.8">
## <!ENTITY COPYRIGHTYEARS "2008-2024">
## <#/GAPDoc>

SetPackageInfo(rec(
Expand All @@ -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 := [
Expand Down
32 changes: 32 additions & 0 deletions lib/doc.g
Original file line number Diff line number Diff line change
@@ -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;
35 changes: 2 additions & 33 deletions makedoc.g
Original file line number Diff line number Diff line change
@@ -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();
LoadPackage("sgpdec");
SgpDecMakeDoc();
2 changes: 1 addition & 1 deletion read.g
Original file line number Diff line number Diff line change
@@ -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");
Expand Down

0 comments on commit c398024

Please sign in to comment.