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{howto}
|
---|
9 |
|
---|
10 | % This is a template for short or medium-size Python-related documents,
|
---|
11 | % mostly notably the series of HOWTOs, but it can be used for any
|
---|
12 | % document you like.
|
---|
13 |
|
---|
14 | % The title should be descriptive enough for people to be able to find
|
---|
15 | % the relevant document.
|
---|
16 | \title{Spammifying Sprockets in Python}
|
---|
17 |
|
---|
18 | % Increment the release number whenever significant changes are made.
|
---|
19 | % The author and/or editor can define 'significant' however they like.
|
---|
20 | \release{0.00}
|
---|
21 |
|
---|
22 | % At minimum, give your name and an email address. You can include a
|
---|
23 | % snail-mail address if you like.
|
---|
24 | \author{Me, 'cause I wrote it}
|
---|
25 | \authoraddress{Me, 'cause I'm self-employed.}
|
---|
26 |
|
---|
27 | \begin{document}
|
---|
28 | \maketitle
|
---|
29 |
|
---|
30 | % This makes the Abstract go on a separate page in the HTML version;
|
---|
31 | % if a copyright notice is used, it should go immediately after this.
|
---|
32 | %
|
---|
33 | \ifhtml
|
---|
34 | \chapter*{Front Matter\label{front}}
|
---|
35 | \fi
|
---|
36 |
|
---|
37 | % Copyright statement should go here, if needed.
|
---|
38 | % ...
|
---|
39 |
|
---|
40 | % The abstract should be a paragraph or two long, and describe the
|
---|
41 | % scope of the document.
|
---|
42 | \begin{abstract}
|
---|
43 | \noindent
|
---|
44 | This document describes how to spammify sprockets. It is a useful
|
---|
45 | example of a Python HOWTO document. It is not dependent on any
|
---|
46 | particular sprocket implementation, and includes a Python-based
|
---|
47 | implementation in the \module{sprunkit} module.
|
---|
48 | \end{abstract}
|
---|
49 |
|
---|
50 | \tableofcontents
|
---|
51 |
|
---|
52 | Spammifying sprockets from Python is both fun and entertaining.
|
---|
53 | Applying the techniques described here, you can also fill your hard
|
---|
54 | disk quite effectively.
|
---|
55 |
|
---|
56 | \section{What is Sprocket Spammification?}
|
---|
57 |
|
---|
58 | You have to ask? It's the only thing to do to your sprockets!
|
---|
59 |
|
---|
60 |
|
---|
61 | \section{Why Use Python?}
|
---|
62 |
|
---|
63 | Python is an excellent language from which to spammify your sprockets
|
---|
64 | since you can do it on any platform.
|
---|
65 |
|
---|
66 |
|
---|
67 | \section{Software Requirements}
|
---|
68 |
|
---|
69 | You need to have the following software installed:
|
---|
70 |
|
---|
71 | % The {itemize} environment uses a bullet for each \item. If you want the
|
---|
72 | % \item's numbered, use the {enumerate} environment instead.
|
---|
73 | \begin{itemize}
|
---|
74 | \item Python 1.9.
|
---|
75 | \item Some sprocket definition files.
|
---|
76 | \item At least one sprocket system implementation.
|
---|
77 | \end{itemize}
|
---|
78 |
|
---|
79 | Note that the \module{sprunkit} is provided with this package and
|
---|
80 | implements ActiveSprockets in Python.
|
---|
81 |
|
---|
82 |
|
---|
83 | % The preceding sections will have been written in a gentler,
|
---|
84 | % introductory style. You may also wish to include a reference
|
---|
85 | % section, documenting all the functions/exceptions/constants.
|
---|
86 | % Often, these will be placed in separate files and input like this:
|
---|
87 |
|
---|
88 | \input{module}
|
---|
89 |
|
---|
90 |
|
---|
91 | \appendix
|
---|
92 |
|
---|
93 | \section{This is an Appendix}
|
---|
94 |
|
---|
95 | To create an appendix in a Python HOWTO document, use markup like
|
---|
96 | this:
|
---|
97 |
|
---|
98 | \begin{verbatim}
|
---|
99 | \appendix
|
---|
100 |
|
---|
101 | \section{This is an Appendix}
|
---|
102 |
|
---|
103 | To create an appendix in a Python HOWTO document, ....
|
---|
104 |
|
---|
105 |
|
---|
106 | \section{This is another}
|
---|
107 |
|
---|
108 | Just add another \section{}, but don't say \appendix again.
|
---|
109 | \end{verbatim}
|
---|
110 |
|
---|
111 |
|
---|
112 | \end{document}
|
---|