buildframework/helium/external/python/lib/common/Sphinx-0.5.1-py2.5.egg/sphinx/texinputs/howto.cls
author wbernard
Wed, 23 Dec 2009 19:29:07 +0200
changeset 179 d8ac696cc51f
permissions -rw-r--r--
helium_7.0-r14027
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
179
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     1
%
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     2
% howto.cls for Sphinx
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     3
%
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     4
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     5
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     6
\ProvidesClass{howto}[2008/10/18 Document class (Sphinx HOWTO)]
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     7
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     8
% Pass all given class options to the parent class.
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
     9
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    10
\ProcessOptions\relax
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    11
\LoadClass[twoside]{article}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    12
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    13
% Set some sane defaults for section numbering depth and TOC depth.  You can
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    14
% reset these counters in your preamble.
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    15
%
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    16
\setcounter{secnumdepth}{2}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    17
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    18
% Change the title page to look a bit better, and fit in with the fncychap
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    19
% ``Bjarne'' style a bit better.
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    20
%
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    21
\renewcommand{\maketitle}{
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    22
  \rule{\textwidth}{1pt}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    23
  \ifsphinxpdfoutput
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    24
    \begingroup
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    25
    % This \def is required to deal with multi-line authors; it
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    26
    % changes \\ to ', ' (comma-space), making it pass muster for
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    27
    % generating document info in the PDF file.
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    28
    \def\\{, }
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    29
    \pdfinfo{
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    30
      /Author (\@author)
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    31
      /Title (\@title)
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    32
    }
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    33
    \endgroup
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    34
  \fi
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    35
  \begin{flushright}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    36
    \sphinxlogo%
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    37
    {\rm\Huge\py@HeaderFamily \@title} \par
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    38
    {\em\large\py@HeaderFamily \py@release\releaseinfo} \par
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    39
    \vspace{25pt}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    40
    {\Large\py@HeaderFamily \@author} \par
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    41
    \vspace{25pt}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    42
    \@date \par
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    43
    \py@authoraddress \par
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    44
  \end{flushright}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    45
  \@thanks
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    46
  \setcounter{footnote}{0}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    47
  \let\thanks\relax\let\maketitle\relax
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    48
  %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    49
}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    50
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    51
\let\py@OldTableofcontents=\tableofcontents
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    52
\renewcommand{\tableofcontents}{
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    53
  \begingroup
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    54
    \parskip = 0mm
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    55
    \py@OldTableofcontents
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    56
  \endgroup
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    57
  \rule{\textwidth}{1pt}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    58
  \vspace{12pt}
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    59
}  
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    60
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    61
\@ifundefined{fancyhf}{
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    62
  \pagestyle{plain}}{
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    63
  \pagestyle{normal}}		% start this way; change for
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    64
\pagenumbering{arabic}		% ToC & chapters
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    65
d8ac696cc51f helium_7.0-r14027
wbernard
parents:
diff changeset
    66
\thispagestyle{empty}