blob: 8093e3b9cd9502101cb74bb185546f9cb63c981e [file] [log] [blame]
jcgregorio26c0cd72006-07-03 17:36:17 +00001% 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{The httplib2 Library}
11
12\author{Joe Gregorio}
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{joe@bitworking.org}
20}
21
jcgregoriocde4f092007-03-08 21:59:04 +000022\date{Mar 8, 2007} % update before release!
jcgregorio26c0cd72006-07-03 17:36:17 +000023
jcgregoriocde4f092007-03-08 21:59:04 +000024\release{0.3} % release version; this is used to define the
jcgregorio26c0cd72006-07-03 17:36:17 +000025 % \version macro
26
27\makeindex % tell \index to actually write the .idx file
28\makemodindex % If this contains a lot of module sections.
29
30
31\begin{document}
32
33\maketitle
34
35% This makes the contents more accessible from the front page of the HTML.
36%\ifhtml
37%\chapter*{Front Matter\label{front}}
38%\fi
39
40%\input{copyright}
41
42\begin{abstract}
43\noindent
44
45The \module{httplib2} module is a comprehensive HTTP client library
46that handles caching, keep-alive, compression, redirects and
47many kinds of authentication.
48
49
50\end{abstract}
51
52\tableofcontents
53
54\chapter{Reference}
55
56\input{libhttplib2.tex}
57
58%\appendix
59%\chapter{...}
60
61%My appendix.
62
63%The \code{\e appendix} markup need not be repeated for additional
64%appendices.
65
66
67
68
69
70
71
72
73%
74% The ugly "%begin{latexonly}" pseudo-environments are really just to
75% keep LaTeX2HTML quiet during the \renewcommand{} macros; they're
76% not really valuable.
77%
78% If you don't want the Module Index, you can remove all of this up
79% until the second \input line.
80%
81%begin{latexonly}
82\renewcommand{\indexname}{Module Index}
83%end{latexonly}
84\input{mod\jobname.ind} % Module Index
85
86%begin{latexonly}
87\renewcommand{\indexname}{Index}
88%end{latexonly}
89\input{\jobname.ind} % Index
90
91\end{document}