File: Macaulay2Doc.m2

package info (click to toggle)
macaulay2 1.21%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 133,096 kB
  • sloc: cpp: 110,377; ansic: 16,306; javascript: 4,193; makefile: 3,821; sh: 3,580; lisp: 764; yacc: 590; xml: 177; python: 140; perl: 114; lex: 65; awk: 3
file content (39 lines) | stat: -rw-r--r-- 1,554 bytes parent folder | download
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
-- -*- coding: utf-8 -*-

-- maybe we can eliminate this package and put all the documentation into the Core package
-- eventually

newPackage ("Macaulay2Doc",
     InfoDirSection => "Macaulay2 and its packages", 
     AuxiliaryFiles => true,
     UseCachedExampleOutput => true,
     Headline => "Macaulay2 documentation", 
     Authors => {
	  {Name => "Daniel R. Grayson", Email => "dan@math.uiuc.edu", HomePage => "http://www.math.uiuc.edu/~dan/"},
	  {Name => "Michael E. Stillman", Email => "mike@math.cornell.edu", HomePage => "http://www.math.cornell.edu/People/Faculty/stillman.html"}
	  },
     Keywords => {"Documentation"},
     PackageExports => Core#"pre-installed packages",
     HomePage => "http://www.math.uiuc.edu/Macaulay2/",
     Version => version#"VERSION")

scan(pairs Core#"raw documentation", (k,v) -> (
	  remove(Core#"raw documentation", k);
	  Macaulay2Doc#"raw documentation"#k = v;
	  ))

beginDocumentation()

-- a local way to use private global symbols from Core
core = nm -> value Core#"private dictionary"#nm
load "./Macaulay2Doc/loads.m2"				    -- the ./ makes it load from the current directory
erase symbol core

if keys Macaulay2Doc#"private dictionary" =!= {} 
then error splice (
     "global symbols inadvertently defined by package Macaulay2Doc: ", 
     toSequence between_", " values Macaulay2Doc#"private dictionary")

-- Local Variables:
-- compile-command: "make -C $M2BUILDDIR/Macaulay2/packages PACKAGES=Macaulay2Doc RemakePackages=false RemakeAllDocumentation=false IgnoreExampleErrors=false"
-- End: