diff options
author | Georg Brandl <georg@python.org> | 2007-08-15 14:26:55 (GMT) |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2007-08-15 14:26:55 (GMT) |
commit | f56181ff53ba00b7bed3997a4dccd9a1b6217b57 (patch) | |
tree | 1200947a7ffc78c2719831e4c7fd900a8ab01368 /Doc/templates | |
parent | af62d9abfb78067a54c769302005f952ed999f6a (diff) | |
download | cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.zip cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.tar.gz cpython-f56181ff53ba00b7bed3997a4dccd9a1b6217b57.tar.bz2 |
Delete the LaTeX doc tree.
Diffstat (limited to 'Doc/templates')
-rw-r--r-- | Doc/templates/howto.tex | 112 | ||||
-rw-r--r-- | Doc/templates/manual.tex | 89 | ||||
-rw-r--r-- | Doc/templates/module.tex | 170 | ||||
-rw-r--r-- | Doc/templates/whatsnewXY.tex | 149 |
4 files changed, 0 insertions, 520 deletions
diff --git a/Doc/templates/howto.tex b/Doc/templates/howto.tex deleted file mode 100644 index fdbb065..0000000 --- a/Doc/templates/howto.tex +++ /dev/null @@ -1,112 +0,0 @@ -% Complete documentation on the extended LaTeX markup used for Python -% documentation is available in ``Documenting Python'', which is part -% of the standard documentation for Python. It may be found online -% at: -% -% http://www.python.org/doc/current/doc/doc.html - -\documentclass{howto} - -% This is a template for short or medium-size Python-related documents, -% mostly notably the series of HOWTOs, but it can be used for any -% document you like. - -% The title should be descriptive enough for people to be able to find -% the relevant document. -\title{Spammifying Sprockets in Python} - -% Increment the release number whenever significant changes are made. -% The author and/or editor can define 'significant' however they like. -\release{0.00} - -% At minimum, give your name and an email address. You can include a -% snail-mail address if you like. -\author{Me, 'cause I wrote it} -\authoraddress{Me, 'cause I'm self-employed.} - -\begin{document} -\maketitle - -% This makes the Abstract go on a separate page in the HTML version; -% if a copyright notice is used, it should go immediately after this. -% -\ifhtml -\chapter*{Front Matter\label{front}} -\fi - -% Copyright statement should go here, if needed. -% ... - -% The abstract should be a paragraph or two long, and describe the -% scope of the document. -\begin{abstract} -\noindent -This document describes how to spammify sprockets. It is a useful -example of a Python HOWTO document. It is not dependent on any -particular sprocket implementation, and includes a Python-based -implementation in the \module{sprunkit} module. -\end{abstract} - -\tableofcontents - -Spammifying sprockets from Python is both fun and entertaining. -Applying the techniques described here, you can also fill your hard -disk quite effectively. - -\section{What is Sprocket Spammification?} - -You have to ask? It's the only thing to do to your sprockets! - - -\section{Why Use Python?} - -Python is an excellent language from which to spammify your sprockets -since you can do it on any platform. - - -\section{Software Requirements} - -You need to have the following software installed: - -% The {itemize} environment uses a bullet for each \item. If you want the -% \item's numbered, use the {enumerate} environment instead. -\begin{itemize} - \item Python 1.9. - \item Some sprocket definition files. - \item At least one sprocket system implementation. -\end{itemize} - -Note that the \module{sprunkit} is provided with this package and -implements ActiveSprockets in Python. - - -% The preceding sections will have been written in a gentler, -% introductory style. You may also wish to include a reference -% section, documenting all the functions/exceptions/constants. -% Often, these will be placed in separate files and input like this: - -\input{module} - - -\appendix - -\section{This is an Appendix} - -To create an appendix in a Python HOWTO document, use markup like -this: - -\begin{verbatim} -\appendix - -\section{This is an Appendix} - -To create an appendix in a Python HOWTO document, .... - - -\section{This is another} - -Just add another \section{}, but don't say \appendix again. -\end{verbatim} - - -\end{document} diff --git a/Doc/templates/manual.tex b/Doc/templates/manual.tex deleted file mode 100644 index 19dec8b..0000000 --- a/Doc/templates/manual.tex +++ /dev/null @@ -1,89 +0,0 @@ -% Complete documentation on the extended LaTeX markup used for Python -% documentation is available in ``Documenting Python'', which is part -% of the standard documentation for Python. It may be found online -% at: -% -% http://www.python.org/doc/current/doc/doc.html - -\documentclass{manual} - -\title{Big Python Manual} - -\author{Your Name Here} - -% Please at least include a long-lived email address; -% the rest is at your discretion. -\authoraddress{ - Organization name, if applicable \\ - Street address, if you want to use it \\ - Email: \email{your-email@your.domain} -} - -\date{April 30, 1999} % update before release! - % Use an explicit date so that reformatting - % doesn't cause a new date to be used. Setting - % the date to \today can be used during draft - % stages to make it easier to handle versions. - -\release{x.y} % release version; this is used to define the - % \version macro - -\makeindex % tell \index to actually write the .idx file -\makemodindex % If this contains a lot of module sections. - - -\begin{document} - -\maketitle - -% This makes the contents more accessible from the front page of the HTML. -\ifhtml -\chapter*{Front Matter\label{front}} -\fi - -%\input{copyright} - -\begin{abstract} - -\noindent -Big Python is a special version of Python for users who require larger -keys on their keyboards. It accommodates their special needs by ... - -\end{abstract} - -\tableofcontents - - -\chapter{...} - -My chapter. - - -\appendix -\chapter{...} - -My appendix. - -The \code{\e appendix} markup need not be repeated for additional -appendices. - - -% -% The ugly "%begin{latexonly}" pseudo-environments are really just to -% keep LaTeX2HTML quiet during the \renewcommand{} macros; they're -% not really valuable. -% -% If you don't want the Module Index, you can remove all of this up -% until the second \input line. -% -%begin{latexonly} -\renewcommand{\indexname}{Module Index} -%end{latexonly} -\input{mod\jobname.ind} % Module Index - -%begin{latexonly} -\renewcommand{\indexname}{Index} -%end{latexonly} -\input{\jobname.ind} % Index - -\end{document} diff --git a/Doc/templates/module.tex b/Doc/templates/module.tex deleted file mode 100644 index 69e1b12..0000000 --- a/Doc/templates/module.tex +++ /dev/null @@ -1,170 +0,0 @@ -% Template for a library manual section. -% PLEASE REMOVE THE COMMENTS AFTER USING THE TEMPLATE -% -% Complete documentation on the extended LaTeX markup used for Python -% documentation is available in ``Documenting Python'', which is part -% of the standard documentation for Python. It may be found online -% at: -% -% http://www.python.org/doc/current/doc/doc.html - -% ==== 0. ==== -% Copy this file to <mydir>/lib<mymodule>.tex, and edit that file -% according to the instructions below. - - -% ==== 1. ==== -% The section prologue. Give the section a title and provide some -% meta-information. References to the module should use -% \refbimodindex, \refstmodindex, \refexmodindex or \refmodindex, as -% appropriate. - -\section{\module{spam} --- - Short description, for section title and table of contents} - -% Choose one of these to specify the module module name. If there's -% an underscore in the name, use -% \declaremodule[modname]{...}{mod_name} instead. -% -\declaremodule{builtin}{spam} % standard library, in C -\declaremodule{standard}{spam} % standard library, in Python -\declaremodule{extension}{spam} % not standard, in C -\declaremodule{}{spam} % not standard, in Python - -% Portability statement: Uncomment and fill in the parameter to specify the -% availability of the module. The parameter can be Unix, IRIX, SunOS, Mac, -% Windows, or lots of other stuff. When ``Mac'' is specified, the availability -% statement will say ``Macintosh'' and the Module Index may say ``Mac''. -% Please use a name that has already been used whenever applicable. If this -% is omitted, no availability statement is produced or implied. -% -% \platform{Unix} - -% These apply to all modules, and may be given more than once: - -\moduleauthor{name}{email} % Author of the module code; - % omit if not known. -\sectionauthor{name}{email} % Author of the documentation, - % even if not a module section. - - -% Leave at least one blank line after this, to simplify ad-hoc tools -% that are sometimes used to massage these files. -\modulesynopsis{This is a one-line description, for the chapter header.} - - -% ==== 2. ==== -% Give a short overview of what the module does. -% If it is platform specific, mention this. -% Mention other important restrictions or general operating principles. -% For example: - -The \module{spam} module defines operations for handling cans of Spam. -It knows the four generally available Spam varieties and understands -both can sizes. - -Because spamification requires \UNIX{} process management, the module -is only available on genuine \UNIX{} systems. - - -% ==== 3. ==== -% List the public functions defined by the module. Begin with a -% standard phrase. You may also list the exceptions and other data -% items defined in the module, insofar as they are important for the -% user. - -The \module{spam} module defines the following functions: - -% ---- 3.1. ---- -% For each function, use a ``funcdesc'' block. This has exactly two -% parameters (each parameters is contained in a set of curly braces): -% the first parameter is the function name (this automatically -% generates an index entry); the second parameter is the function's -% argument list. If there are no arguments, use an empty pair of -% curly braces. If there is more than one argument, separate the -% arguments with backslash-comma. Optional parts of the parameter -% list are contained in \optional{...} (this generates a set of square -% brackets around its parameter). Arguments are automatically set in -% italics in the parameter list. Each argument should be mentioned at -% least once in the description; each usage (even inside \code{...}) -% should be enclosed in \var{...}. - -\begin{funcdesc}{open}{filename\optional{, mode\optional{, buffersize}}} -Open the file \var{filename} as a can of Spam. The optional -\var{mode} and \var{buffersize} arguments specify the read/write mode -(\code{'r'} (default) or \code{'w'}) and the buffer size (default: -system dependent). -\end{funcdesc} - -% ---- 3.2. ---- -% Data items are described using a ``datadesc'' block. This has only -% one parameter: the item's name. - -\begin{datadesc}{cansize} -The default can size, in ounces. Legal values are 7 and 12. The -default varies per supermarket. This variable should not be changed -once the \function{open()} function has been called. -\end{datadesc} - -% --- 3.3. --- -% Exceptions are described using a ``excdesc'' block. This has only -% one parameter: the exception name. Exceptions defined as classes in -% the source code should be documented using this environment, but -% constructor parameters must be omitted. - -\begin{excdesc}{error} -Exception raised when an operation fails for a Spam specific reason. -The exception argument is a string describing the reason of the -failure. -\end{excdesc} - -% ---- 3.4. ---- -% Other standard environments: -% -% classdesc - Python classes; same arguments are funcdesc -% methoddesc - methods, like funcdesc but has an optional parameter -% to give the type name: \begin{methoddesc}[mytype]{name}{args} -% By default, the type name will be the name of the -% last class defined using classdesc. The type name -% is required if the type is implemented in C (because -% there's no classdesc) or if the class isn't directly -% documented (if it's private). -% memberdesc - data members, like datadesc, but with an optional -% type name like methoddesc. - - -% ==== 4. ==== -% Now is probably a good time for a complete example. (Alternatively, -% an example giving the flavor of the module may be given before the -% detailed list of functions.) - -\subsection{Example \label{spam-example}} - -The following example demonstrates how to open a can of spam using the -\module{spam} module. - -\begin{verbatim} ->>> import spam ->>> can = spam.open('/etc/passwd') ->>> can.empty() ->>> can.close() -\end{verbatim} -% Note that there is no trailing ">>> " prompt shown. - -% ==== 5. ==== -% If your module defines new object types (for a built-in module) or -% classes (for a module written in Python), you should list the -% methods and instance variables (if any) of each type or class in a -% separate subsection. - -\subsection{Spam Objects} -\label{spam-objects} -% This label is generally useful for referencing this section, but is -% also used to give a filename when generating HTML. - -Spam objects, as returned by \function{open()} above, have the -following methods: - -\begin{methoddesc}[spam]{empty}{} -Empty the can into the trash. -\end{methoddesc} diff --git a/Doc/templates/whatsnewXY.tex b/Doc/templates/whatsnewXY.tex deleted file mode 100644 index 6f62b9c..0000000 --- a/Doc/templates/whatsnewXY.tex +++ /dev/null @@ -1,149 +0,0 @@ -\documentclass{howto} -\usepackage{distutils} -% $Id$ - -% When creating a new ``What's New'' document, copy this to -% ../whatsnew/whatsnewXY.tex, where X is replaced by the major version -% number and Y, by the minor version number for the release of Python -% being described. -% -% The following replacements need to be made in the text: -% -% X.Y -- the version of Python this document describes -% X.Y-1 -- previous minor release (not a maintenance release) -% X.Y-2 -- minor release before that one (optional; search the -% template to see the usage -% -% Once done, write and edit to your heart's content! - -\title{What's New in Python X.Y} -\release{0.0} -\author{Young Author} -\authoraddress{\email{ya@example.com}} - -\begin{document} -\maketitle -\tableofcontents - -This article explains the new features in Python X.Y. No release date -for Python X.Y has been set; expect that this will happen next year. - -% Compare with previous release in 2 - 3 sentences here. - -This article doesn't attempt to provide a complete specification of -the new features, but instead provides a convenient overview. For -full details, you should refer to the documentation for Python X.Y. -% add hyperlink when the documentation becomes available online. -If you want to understand the complete implementation and design -rationale, refer to the PEP for a particular new feature. - - -%====================================================================== - -% Large, PEP-level features and changes should be described here. - - -%====================================================================== -\section{Other Language Changes} - -Here are all of the changes that Python X.Y makes to the core Python -language. - -\begin{itemize} -\item TBD - -\end{itemize} - - -%====================================================================== -\subsection{Optimizations} - -\begin{itemize} - -\item Optimizations should be described here. - -\end{itemize} - -The net result of the X.Y optimizations is that Python X.Y runs the -pystone benchmark around XX\% faster than Python X.Y-1.% -% only use the next line if you want to do the extra work ;) : -% and YY\% faster than Python X.Y-2. - - -%====================================================================== -\section{New, Improved, and Deprecated Modules} - -As usual, Python's standard library received a number of enhancements and -bug fixes. Here's a partial list of the most notable changes, sorted -alphabetically by module name. Consult the -\file{Misc/NEWS} file in the source tree for a more -complete list of changes, or look through the CVS logs for all the -details. - -\begin{itemize} - -\item Descriptions go here. - -\end{itemize} - - -%====================================================================== -% whole new modules get described in \subsections here - - -% ====================================================================== -\section{Build and C API Changes} - -Changes to Python's build process and to the C API include: - -\begin{itemize} - -\item Detailed changes are listed here. - -\end{itemize} - - -%====================================================================== -\subsection{Port-Specific Changes} - -Platform-specific changes go here. - - -%====================================================================== -\section{Other Changes and Fixes \label{section-other}} - -As usual, there were a bunch of other improvements and bugfixes -scattered throughout the source tree. A search through the CVS change -logs finds there were XXX patches applied and YYY bugs fixed between -Python X.Y-1 and X.Y. Both figures are likely to be underestimates. - -Some of the more notable changes are: - -\begin{itemize} - -\item Details go here. - -\end{itemize} - - -%====================================================================== -\section{Porting to Python X.Y} - -This section lists previously described changes that may require -changes to your code: - -\begin{itemize} - -\item Everything is all in the details! - -\end{itemize} - - -%====================================================================== -\section{Acknowledgements \label{acks}} - -The author would like to thank the following people for offering -suggestions, corrections and assistance with various drafts of this -article: . - -\end{document} |