graphviz/PackageInfo.g at main · digraphs/graphviz · GitHub

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
#############################################################################
##
##  PackageInfo.g
##  Copyright (C) 2024                                      Matthew Pancer
##
##  Licensing information can be found in the README file of this package.
##
#############################################################################
##

SetPackageInfo(rec(

PackageName := "graphviz",
Subtitle    := "GAP representations of graphviz objects",
Version     := "0.0.0",
Date        := "09/04/2022",  # dd/mm/yyyy format
License     := "GPL-2.0-or-later",

Persons := [
  rec(
    FirstNames    := "James D.",
    LastName      := "Mitchell",
    WWWHome       := "https://jdbm.me",
    Email         := "jdm3@st-andrews.ac.uk",
    IsAuthor      := true,
    IsMaintainer  := true,
    PostalAddress := Concatenation("Mathematical Institute, North Haugh,",
                     " St Andrews, Fife, KY16 9SS, Scotland"),
    Place       := "St Andrews",
    Institution := "University of St Andrews"),
  rec(
    FirstNames    := "Matthew",
    LastName      := "Pancer",
    WWWHome       := "https://github.com/mpan322",
                     # TODO make personal website
    Email         := "mp322@st-andrews.ac.uk",
    IsAuthor      := true,
    IsMaintainer  := true,
    PostalAddress := Concatenation("Mathematical Institute, North Haugh,",
                     " St Andrews, Fife, KY16 9SS, Scotland"),
                     # TODO correct? Or should be cs?
    Place       := "St Andrews",
    Institution := "University of St Andrews")],

Status := "dev",

SourceRepository := rec(Type := "git",
                        URL  := "https://github.com/digraphs/graphviz"),
IssueTrackerURL := "https://github.com/digraphs/graphviz/issues",
PackageWWWHome  := Concatenation("https://digraphs.github.io/",
                                 ~.PackageName),

PackageInfoURL := Concatenation(~.PackageWWWHome, "PackageInfo.g"),
README_URL     := Concatenation(~.PackageWWWHome, "README.md"),
ArchiveURL     := Concatenation(~.PackageWWWHome,
                                "/",
                                ~.PackageName,
                                "-",
                                ~.Version),
ArchiveFormats := ".tar.gz",

PackageDoc := rec(
  BookName  := "graphviz",
  ArchiveURLSubset := ["doc"],
  HTMLStart := "doc/chap0.html",
  PDFFile   := "doc/manual.pdf",
  SixFile   := "doc/manual.six",
  LongTitle := "TODO",
),

Dependencies := rec(
  GAP := ">= 4.11.0",
  NeededOtherPackages := [],
  SuggestedOtherPackages := [],
  ExternalConditions := [],
),

AvailabilityTest := ReturnTrue,

TestFile := "tst/testall.g",

AutoDoc := rec(
    TitlePage := rec(
        Copyright := """&copyright; by J. D. Mitchell and M. Pancer.<P/>
        &GAPGraphviz; is free software; you can redistribute it and/or modify
        it, under the terms of the GNU General Public License, version 3 of
        the License, or (at your option) any later, version.""",
        Abstract := """
        This package facilitates the creation and rendering of graph
        descriptions in the &DOT; language of the &Graphviz; graph drawing
        software from &GAP;.
        <P/>

        Create a graphviz object, assemble the graph by adding nodes and
        edges, and retrieve its &DOT; source code string. Save the source
        code to a file and render it with the &Graphviz; installation of your
        system.
        <P/>

        Use the <Ref Func="Splash"/> function to directly inspect the resulting
        graph.
        <P/>

        This package was inspired by the python package of the same name
        &PyGraphviz;.""")),

AbstractHTML := ~.AutoDoc.TitlePage.Abstract));