Doc/templates/manual.tex

   1 % Complete documentation on the extended LaTeX markup used for Python
   2 % documentation is available in ``Documenting Python'', which is part
   3 % of the standard documentation for Python.  It may be found online
   4 % at:
   5 %
   6 %     http://www.python.org/doc/current/doc/doc.html
   7
   8 \documentclass{manual}
   9
  10 \title{Big Python Manual}
  11
  12 \author{Your Name Here}
  13
  14 % Please at least include a long-lived email address;
  15 % the rest is at your discretion.
  16 \authoraddress{
  17         Organization name, if applicable \\
  18         Street address, if you want to use it \\
  19         Email: \email{your-email@your.domain}
  20 }
  21
  22 \date{April 30, 1999}           % update before release!
  23                                 % Use an explicit date so that reformatting
  24                                 % doesn't cause a new date to be used.  Setting
  25                                 % the date to \today can be used during draft
  26                                 % stages to make it easier to handle versions.
  27
  28 \release{x.y}                   % release version; this is used to define the
  29                                 % \version macro
  30
  31 \makeindex                      % tell \index to actually write the .idx file
  32 \makemodindex                   % If this contains a lot of module sections.
  33
  34
  35 \begin{document}
  36
  37 \maketitle
  38
  39 % This makes the contents more accessible from the front page of the HTML.
  40 \ifhtml
  41 \chapter*{Front Matter\label{front}}
  42 \fi
  43
  44 %\input{copyright}
  45
  46 \begin{abstract}
  47
  48 \noindent
  49 Big Python is a special version of Python for users who require larger
  50 keys on their keyboards.  It accommodates their special needs by ...
  51
  52 \end{abstract}
  53
  54 \tableofcontents
  55
  56
  57 \chapter{...}
  58
  59 My chapter.
  60
  61
  62 \appendix
  63 \chapter{...}
  64
  65 My appendix.
  66
  67 The \code{\e appendix} markup need not be repeated for additional
  68 appendices.
  69
  70
  71 %
  72 %  The ugly "%begin{latexonly}" pseudo-environments are really just to
  73 %  keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
  74 %  not really valuable.
  75 %
  76 %  If you don't want the Module Index, you can remove all of this up
  77 %  until the second \input line.
  78 %
  79 %begin{latexonly}
  80 \renewcommand{\indexname}{Module Index}
  81 %end{latexonly}
  82 \input{mod\jobname.ind}         % Module Index
  83
  84 %begin{latexonly}
  85 \renewcommand{\indexname}{Index}
  86 %end{latexonly}
  87 \input{\jobname.ind}                    % Index
  88
  89 \end{document}