1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
|
# AutoDoc: Generate documentation from GAP source code
#
# Copyright of AutoDoc belongs to its developers.
# Please refer to the COPYRIGHT file for details.
#
# SPDX-License-Identifier: GPL-2.0-or-later
SetPackageInfo( rec(
PackageName := "AutoDoc",
Subtitle := "Generate documentation from GAP source code",
Version := "2023.06.19",
Date := ~.Version{[ 1 .. 10 ]},
Date := Concatenation( ~.Date{[ 9, 10 ]}, "/", ~.Date{[ 6, 7 ]}, "/", ~.Date{[ 1 .. 4 ]} ),
License := "GPL-2.0-or-later",
Persons := [
rec(
LastName := "Gutsche",
FirstNames := "Sebastian",
IsAuthor := true,
IsMaintainer := true,
Email := "gutsche@mathematik.uni-siegen.de",
WWWHome := "https://algebra.mathematik.uni-siegen.de/gutsche/",
PostalAddress := Concatenation(
"Department Mathematik\n",
"Universität Siegen\n",
"Walter-Flex-Straße 3\n",
"57072 Siegen\n",
"Germany" ),
Place := "Siegen",
Institution := "Universität Siegen"
),
rec( LastName := "Horn",
FirstNames := "Max",
IsAuthor := true,
IsMaintainer := true,
Email := "mhorn@rptu.de",
WWWHome := "https://www.quendi.de/math",
PostalAddress := Concatenation(
"Fachbereich Mathematik\n",
"RPTU Kaiserslautern-Landau\n",
"Gottlieb-Daimler-Straße 48\n",
"67663 Kaiserslautern\n",
"Germany" ),
Place := "Kaiserslautern, Germany",
Institution := "RPTU Kaiserslautern-Landau"
),
# Contributors:
rec( LastName := "Barakat",
FirstNames := "Mohamed",
IsAuthor := false,
IsMaintainer := false,
),
rec( LastName := "Pfeiffer",
FirstNames := "Markus",
IsAuthor := false,
IsMaintainer := false,
),
rec( LastName := "Skartsæterhagen",
FirstNames := "Øystein",
IsAuthor := false,
IsMaintainer := false,
),
rec( LastName := "Wensley",
FirstNames := "Chris",
IsAuthor := false,
IsMaintainer := false,
),
rec( LastName := "Whitney",
FirstNames := "Glen",
IsAuthor := false,
IsMaintainer := false,
),
rec( LastName := "Zickgraf",
FirstNames := "Fabian",
IsAuthor := false,
IsMaintainer := false,
),
],
Status := "deposited",
PackageWWWHome := "https://gap-packages.github.io/AutoDoc/",
SourceRepository := rec(
Type := "git",
URL := Concatenation( "https://github.com/gap-packages/", ~.PackageName ),
),
IssueTrackerURL := Concatenation( ~.SourceRepository.URL, "/issues" ),
PackageWWWHome := Concatenation( "https://gap-packages.github.io/", ~.PackageName ),
README_URL := Concatenation( ~.PackageWWWHome, "/README.md" ),
PackageInfoURL := Concatenation( ~.PackageWWWHome, "/PackageInfo.g" ),
ArchiveURL := Concatenation( ~.SourceRepository.URL,
"/releases/download/v", ~.Version,
"/", ~.PackageName, "-", ~.Version ),
ArchiveFormats := ".tar.gz",
AbstractHTML :=
"",
PackageDoc := rec(
BookName := "AutoDoc",
ArchiveURLSubset := ["doc"],
HTMLStart := "doc/chap0_mj.html",
PDFFile := "doc/manual.pdf",
SixFile := "doc/manual.six",
LongTitle := "Generate documentation from GAP source code",
),
Dependencies := rec(
GAP := ">= 4.5",
NeededOtherPackages := [ [ "GAPDoc", ">= 1.6.3" ] ],
SuggestedOtherPackages := [ ],
ExternalConditions := [],
),
AvailabilityTest := ReturnTrue,
TestFile := "tst/testall.g",
Keywords := [ "Automatic documentation, GAP, GAPDoc" ],
AutoDoc := rec(
entities := rec(
VERSION := ~.Version,
DATE := ~.Date,
io := "<Package>io</Package>",
PackageName := "<Package>PackageName</Package>",
),
TitlePage := rec(
Copyright := Concatenation(
"©right; 2012-2022 by Sebastian Gutsche and Max Horn<P/>\n\n",
"This package may be distributed under the terms and conditions ",
"of the GNU Public License Version 2 or (at your option) any later version.\n"
),
Abstract := Concatenation(
"&AutoDoc; is a &GAP; package whose purpose is to aid ",
"&GAP; package authors in creating and maintaining the ",
"documentation of their packages.\n"
),
Acknowledgements := Concatenation(
"This documentation was prepared using the ",
"&GAPDoc; package <Cite Key='GAPDoc'/>.\n",
"<P/>\n"
),
),
),
));
|