Doc/python-docs.txt

   1 This message is being sent in response to your message to the Python
   2 documentation maintainers (docs@python.org).  Your message will
   3 be handled by a human, but this message serves to answer the most
   4 common questions sent to this address.
   5
   6 You will only receive this message if it has not been sent to you for
   7 at least three months.
   8
   9 If your question is answered below, you may not receive an additional
  10 message from the documentation maintainers.  If you feel the answers
  11 below are not sufficient and you do not receive an additional response
  12 within a week, please do send a note letting us know that your
  13 question has not been properly answered, and be specific regarding
  14 what additional information you are looking for.
  15
  16
  17   -Fred
  18
  19
  20 Frequently Asked Questions about the Python Documentation
  21 ---------------------------------------------------------
  22
  23   1.  Can I download HTML/PDF/PostScript versions of the docs?
  24   2.  Where can I download Python?
  25   3.  I can't unpack a downloaded copy on Windows; what should I do?
  26   4.  I can't unpack a downloaded copy on MacOS; what should I do?
  27   5.  What can I use Python for?
  28   6.  How do I use module/function/whatever XXX?
  29   7.  What about JPython?
  30   8.  I found a bug in the documentation, who should I tell?
  31   9.  Can I get an algorithm to do THIS in language THAT?
  32  10.  How do I decode an XXX file from my email on a YYY computer?
  33  11.  Acrobat Reader won't print the PDF.  What's wrong?
  34  12.  Where can I find documentation in my native language?
  35
  36
  37 Answers to the Questions
  38 ------------------------
  39
  40   1.  Can I download HTML/PDF/PostScript/<other> versions of the docs?
  41
  42       Yes.  These are available via the Web and traditional FTP.  For
  43       Web access to the latest version, see:
  44
  45           http://www.python.org/doc/
  46
  47       For FTP access to the latest version and archives of previous
  48       versions, see:
  49
  50           ftp.python.org:/pub/python/doc/
  51
  52   2.  Where can I download Python?
  53
  54       You can get Python in source form and as a Windows installer
  55       from the main Python website.  You can also find information
  56       about pre-built packages for other platforms there as well.
  57
  58       Downloading information at the website is at the URL:
  59
  60           http://www.python.org/download/
  61
  62       The sources and Windows installer can be downloaded from the FTP
  63       site as well:
  64
  65           ftp://ftp.python.org/pub/python/
  66
  67   3.  I can't unpack a downloaded archive on Windows; what should I do?
  68
  69       Make sure the archive was saved with the .tgz extension; you may
  70       need to watch carefully when telling the browser where to save
  71       the file, as the default may change the extension to .tar or
  72       even .exe.
  73
  74       Once you're sure the file has the right extension, use a recent
  75       version of WinZip to upack the file (version 7.0 works).  Get
  76       WinZip from:
  77
  78           http://www.winzip.com/
  79
  80   4.  I can't unpack a downloaded archive on MacOS; what should I do?
  81
  82       Stuffit Expander 4.5 (and probably other versions) cannot handle
  83       the "tar" archive, although it can decompress it from the .tgz
  84       file.  Expander Enhancer, which you have to pay for, can handle
  85       the tar archive.
  86
  87   5.  What can I use Python for?
  88
  89       Python is a general purpose programming language.  See the
  90       Python home page at http://www.python.org/ for more information;
  91       introductory material is available at:
  92
  93           http://www.python.org/doc/Intros.html
  94
  95   6.  How do I use module/function/whatever XXX?
  96
  97       Start by reading the documentation for XXX.  If the
  98       documentation doesn't make sense or seems incomplete, please
  99       file a specific bug report to docs@python.org (the
 100       address you sent your question to).  Otherwise, you probably
 101       sent your question to the wrong place (which does not preclude
 102       an answer, if I know it).
 103
 104       If you're looking for examples or tutorial information on how to
 105       use a particular Python library component, check the Demo/
 106       directory of the source distribution or Windows installation;
 107       there might be an example.  If that doesn't help, point your Web
 108       browser to http://www.python.org/doc/ and look around; there may
 109       be a link to some interesting examples online.  After that, try
 110       searching the Python Web site at http://www.python.org/search/.
 111
 112       If your question still hasn't been answered, you may send your
 113       query to the Python newsgroup (comp.lang.python) or the mailing
 114       list (see http://www.python.org/mailman/listinfo/python-list).
 115       If you'd rather not send you message to a public forum, you can
 116       try sending it to python-help@python.org.  (This is typically
 117       slower than sending your question to the public list, however.)
 118
 119   7.  What about Jython and JPython?
 120
 121       If your question is specific to Jython or JPython, you should
 122       consult the Jython website at:
 123
 124           http://www.jython.org/
 125
 126       Chances are very good that the person who answers questions
 127       posted to docs@python.org doesn't use Jython very often,
 128       and won't be able to give you a meaningful answer beyond "Look
 129       at the Jython website."  Sorry, I don't have *all* the answers!
 130
 131   8.  I found a bug in the documentation, who should I tell?
 132
 133       If you're reading this, you've found the right address!  Send
 134       all documentation bug reports to docs@python.org.  If
 135       you prefer to use a Web-based reporting mechanism, you can use
 136       the bug database at http://www.python.org/python-bugs/.
 137
 138   9.  Can I get an algorithm to do THIS in language THAT?
 139
 140       If THAT is Python, look in the standard library.  If THAT isn't
 141       Python, use your favorite Internet search engine.
 142
 143  10.  How do I decode an XXX file from my email on a YYY computer?
 144
 145       I really, honestly do not know.  I don't even know why this
 146       question gets asked here.  Since I don't have a YYY computer,
 147       I couldn't even try a few things out for you.
 148
 149  11.  Acrobat Reader won't print the PDF.  What's wrong?
 150
 151       Adobe has reportedly admitted that there is a bug in Acrobat Reader
 152       5.0 which causes it not to print at least some PDF files
 153       generated by pdfTeX.  This software is used to produce the PDF
 154       version of the Python documentation, and our documents
 155       definately trigger this bug in Acrobat Reader.  To print the PDF
 156       files, use Acrobat Reader 4.x, ghostscript, or xpdf.
 157
 158       Information on ghostscript can be found at:
 159
 160           http://www.ghostscript.com/
 161
 162       Information on xpdf can be found at:
 163
 164           http://www.foolabs.com/xpdf/
 165
 166  12.  There is a lot of contributed documentation in languages other
 167       than English.  Some of the documents are translations of English
 168       documents, and others were originally authored in other
 169       languages.  If we know about it, it will be listed at:
 170
 171           http://www.python.org/doc/NonEnglish.html