Doc/api/api.tex

   1 \documentclass{manual}
   2
   3 \title{Python/C API Reference Manual}
   4
   5 \input{boilerplate}
   6
   7 \makeindex                      % tell \index to actually write the .idx file
   8
   9
  10 \begin{document}
  11
  12 \maketitle
  13
  14 \ifhtml
  15 \chapter*{Front Matter\label{front}}
  16 \fi
  17
  18 \input{copyright}
  19
  20 \begin{abstract}
  21
  22 \noindent
  23 This manual documents the API used by C and \Cpp{} programmers who
  24 want to write extension modules or embed Python.  It is a companion to
  25 \citetitle[../ext/ext.html]{Extending and Embedding the Python
  26 Interpreter}, which describes the general principles of extension
  27 writing but does not document the API functions in detail.
  28
  29 \warning{The current version of this document is incomplete.  I hope
  30 that it is nevertheless useful.  I will continue to work on it, and
  31 release new versions from time to time, independent from Python source
  32 code releases.}
  33
  34 \end{abstract}
  35
  36 \tableofcontents
  37
  38
  39 \input{intro}
  40 \input{veryhigh}
  41 \input{refcounting}
  42 \input{exceptions}
  43 \input{utilities}
  44 \input{abstract}
  45 \input{concrete}
  46 \input{init}
  47 \input{memory}
  48 \input{newtypes}
  49
  50
  51 % \chapter{Debugging \label{debugging}}
  52 %
  53 % XXX Explain Py_DEBUG, Py_TRACE_REFS, Py_REF_DEBUG.
  54
  55
  56 \appendix
  57 \chapter{Reporting Bugs}
  58 \input{reportingbugs}
  59
  60 \chapter{History and License}
  61 \input{license}
  62
  63 \input{api.ind}                 % Index -- must be last
  64
  65 \end{document}