Commits

Anonymous committed 36de045

documentation updates

  • Participants
  • Parent commits bbec311

Comments (0)

Files changed (7)

 
 <hr>
 
-
-<br><big><b>Miscellaneous</b></big>
-<li><a href=logos.html>Logos</a></li>
-<br>&nbsp;<br><font size=+1><b>Text File Documentation</b></font><br><li><a href=../install.html>install</a> - <html><head>Installation Instructions</li>
-<li><a href=../readme.html>readme</a> - <html><head>Readme Information</li>
+<font size=+1><b>Basic Documentation</b></font><br><li><a href=../readme.html>Readme</a> - Pygame Readme Information
+</li>
+<li><a href=../install.html>Install</a> - Install Information
+</li>
 <li><a href=LGPL>LGPL</a> - Gnu lesser general public license</li>
-<li><a href=init.txt>init</a> - Information about importing and initializing pygame</li><br>&nbsp;<br><font size=+1><b>Tutorials</b></font><br><li><a href=tut/ChimpLineByLine.html>ChimpLineByLine</a> - Line by Line Descriptions of the Chimp Example
+<li><a href=logos.html>Logos</a> - Pygame Logos
+</li><br>&nbsp;<br><font size=+1><b>Tutorials / Introductions</b></font><br><li><a href=tut/ChimpLineByLine.html>ChimpLineByLine</a> - Line by Line Descriptions of the Chimp Example
 </li>
 <li><a href=tut/DisplayModes.html>DisplayModes</a> - Choosing and Configuring Display Modes
 </li>
 <li><a href=tut/Executable.html>Executable</a> - Creating a Standalone Windows Executable
 </li>
+<li><a href=tut/ImportInit.html>ImportInit</a> - Import and Initialize
+</li>
 <li><a href=tut/MoveIt.html>MoveIt</a> - Help! How Do I Move An Image?
 </li>
 <li><a href=tut/SpriteIntro.html>SpriteIntro</a> - Sprite Module Introduction
 </li>
 <li><a href=tut/SurfarrayIntro.html>SurfarrayIntro</a> - Introduction to the surfarray module
 </li>
-<li><a href=tut/newbieguide.html>newbieguide</a> - A Newbie Guide To Pygame
+<li><a href=tut/newbieguide.html>Newbieguide</a> - A Newbie Guide To Pygame
 </li>
 <br><hr><br><font size=+1><b>Full Index</b></font><ul>
 <!--FULLINDEX-->
-<html>
-<title>Pygame Logos</title>
-<body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
+<html> <title>Pygame Logos</title><!--
+Pygame Logos
+--><body bgcolor=#aaeebb text=#000000 link=#331111 vlink=#331111>
 
 
 <table cellspacing=3 width=100%><tr><td bgcolor=#00000>

docs/tut/Executable.html

  
 <h1 align=center><font size=-1>Pygame Tutorials</font><br>Windows Executables</h1>
 <h2 align=center>by Pete Shinners<br><font size=-1>pete@shinners.org</font></h2>
-<h3 align=center>Revision 1.1, February 12th, 2001</h3>
+<h3 align=center>Revision 1.2, January 28th, 2002</h3>
 <br><br>
 
 
 dependencies that your game requires. In order for people to play your game,
 they need a lot of libraries installed. For unix users, this isn't too bad,
 since most unix distributions come with their own package and dependency
-management system. On Windows there is nothing like this, and it is almost
-impossible for a Windows user to just download your python source and run your
+management system. On Windows there is nothing like this, and it is more
+difficult for a Windows user to just download your python source and run your
 game.
 <br>&nbsp;<br>
 The best solution is to create a collection of all the needed files for your
 
 The <tt>icon_file</tt> variable is an optional name of a .ICO file to use
 for the executable. You can leave it empty ("") and it will be ignored.
+Also be warned the icon_file doesn't work too well, especially on windows9x.
 <br>&nbsp;<br>
 
 The <tt>data_directories</tt> is a list of paths that will be copies into
 to all your friends. They do not need any versions of python or SDL installed on
 their machines. Even if they have older versions of python </i>(like version
 1.5.2)</i>, it will not interfere with your game.
+<br>&nbsp;<br>
+
+You can also safely pick through the final game directory, and remove any
+of the "PYD" files that you don't expect your game to use. for example, if
+you don't use joysticks in your game, you can remove the "joystick.pyd"
+to make your game size a little smaller.
+
 
 <br>&nbsp;<br>&nbsp;<br>
 <h2>Creating an Actual Installer</h2>

docs/util/makedocs.py

     return [modules, extras, funcs]
 
 
+def getdocinfo(file, prefix=''):
+    path = os.path.join(prefix, file[3:])
+    prettyname = (os.path.splitext(os.path.split(file)[-1])[0])
+    prettyname = prettyname[0].capitalize() + prettyname[1:]
+    if file.find('html') >= 0:
+        info = open(file).readlines(2)[1]
+    else:
+        info = open(file).readline().strip().capitalize()
+    return path, prettyname, info
+
+
 def findtutorials():
     fileline = '<li><a href=%s>%s</a> - %s</li>'
-    texthead = '<font size=+1><b>Text File Documentation</b></font><br>'
-    tuthead = '<font size=+1><b>Tutorials</b></font><br>'
-    texts1 = glob.glob('../*.txt') + ['../LGPL', '../../readme.html', '../../install.html']
-    texts1.sort()
-    texts2 = [x[3:] for x in texts1]
-    texts3 = [os.path.splitext(os.path.split(x)[-1])[0] for x in texts2]
-    texts4 = [open(x).readline().strip().capitalize() for x in texts1]
-    texts = [fileline%x for x in zip(texts2, texts3, texts4)]
+    texthead = '<font size=+1><b>Basic Documentation</b></font><br>'
+    tuthead = '<font size=+1><b>Tutorials / Introductions</b></font><br>'
+    texts1 =  ['../../readme.html', '../../install.html', '../LGPL', '../logos.html']
+    texts = [fileline%x for x in [getdocinfo(x) for x in texts1]]
     finaltext = texthead + '\n'.join(texts)
-    tuts1 =  glob.glob('../tut/*.html')
+    tuts1 =  glob.glob('../tut/*.html') 
     tuts1.sort()
-    tuts2 = ['tut/' + os.path.split(x)[1] for x in tuts1]
-    tuts3 = [os.path.split(os.path.splitext(x)[0])[-1] for x in tuts2]
-    tuts4 = [open(x).readlines(2)[1] for x in tuts1]
-    tuts = [fileline%(x[0],x[1],x[2][9:]) for x in zip(tuts2, tuts3, tuts4) if x[2].startswith('TUTORIAL:')]
+    tuts = [fileline%(x[0],x[1],x[2][9:]) for x in [getdocinfo(x) for x in tuts1] if x[2].startswith('TUTORIAL:')]
     finaltut = tuthead + '\n'.join(tuts)
     return finaltext + '<br>&nbsp;<br>' + finaltut
 
     writefuncdoc(alldocs)
 
     fulldocs = findtutorials() + makefullindex(alldocs)
-    fulldocs = """
-<br><big><b>Miscellaneous</b></big>
-<li><a href=logos.html>Logos</a></li>
-<br>&nbsp;<br>""" + fulldocs
+    fulldocs = fulldocs
 
 
 
 <html><head><!--
-TUTORIAL:Line by Line Descriptions of the Chimp Example
+Install Information
 --><title>Pygame Installation</title></head><body>
 <h2 align=center>Pygame Installation</h2>
 
 you can easily fix the SMPEG line in the "Setup" script to
 use the correct flags. Then also uncomment the line for the
 "movie" module.
+<p></p>
+Several users have run into error compiling when trying to use the
+Numeric Python header files. This is a problem with the autoconfigure
+script. The script foolishly assumes if it can import the Numeric
+module, then the headers will be available for compile. You need
+to either install the correct "python-numeric-dev" package for your
+system, or comment out the line for "surfarray" in the "Setup" file.
 </p></blockquote><br>
 
 <big><b><u>OSX Compiling Info</u></b></big><blockquote><p>
      can easily fix the SMPEG line in the "Setup" script to use the
      correct flags. Then also uncomment the line for the "movie" module.
 
+     Several users have run into error compiling when trying to use the
+     Numeric Python header files. This is a problem with the
+     autoconfigure script. The script foolishly assumes if it can import
+     the Numeric module, then the headers will be available for compile.
+     You need to either install the correct "python-numeric-dev" package
+     for your system, or comment out the line for "surfarray" in the
+     "Setup" file.
+
    OSX Compiling Info
 
      Building pygame on OSX is not really supported yet. Actually, the
 <html><head><!--
-TUTORIAL:Line by Line Descriptions of the Chimp Example
+Pygame Readme Information
 --><title>Pygame Readme</title></head><body>
 
 <table width=100% border=1><tr><td colspan=3 align=center>