Statistics
| Branch: | Tag: | Revision:

root / docs / build / latex / manual.cls @ 216bb34c

History | View | Annotate | Download (2.8 kB)

1 216bb34c Shikhar Bhushan
%
2 216bb34c Shikhar Bhushan
% manual.cls for Sphinx
3 216bb34c Shikhar Bhushan
%
4 216bb34c Shikhar Bhushan
5 216bb34c Shikhar Bhushan
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
6 216bb34c Shikhar Bhushan
\ProvidesClass{manual}[2008/10/18 Document class (Sphinx manual)]
7 216bb34c Shikhar Bhushan
8 216bb34c Shikhar Bhushan
% Pass all given class options to the parent class.
9 216bb34c Shikhar Bhushan
\DeclareOption*{\PassOptionsToClass{\CurrentOption}{report}}
10 216bb34c Shikhar Bhushan
\ProcessOptions\relax
11 216bb34c Shikhar Bhushan
\LoadClass[twoside,openright]{report}
12 216bb34c Shikhar Bhushan
13 216bb34c Shikhar Bhushan
% Set some sane defaults for section numbering depth and TOC depth.  You can
14 216bb34c Shikhar Bhushan
% reset these counters in your preamble.
15 216bb34c Shikhar Bhushan
%
16 216bb34c Shikhar Bhushan
\setcounter{secnumdepth}{2}
17 216bb34c Shikhar Bhushan
\setcounter{tocdepth}{1}
18 216bb34c Shikhar Bhushan
19 216bb34c Shikhar Bhushan
% Change the title page to look a bit better, and fit in with the fncychap
20 216bb34c Shikhar Bhushan
% ``Bjarne'' style a bit better.
21 216bb34c Shikhar Bhushan
%
22 216bb34c Shikhar Bhushan
\renewcommand{\maketitle}{%
23 216bb34c Shikhar Bhushan
  \begin{titlepage}%
24 216bb34c Shikhar Bhushan
    \let\footnotesize\small
25 216bb34c Shikhar Bhushan
    \let\footnoterule\relax
26 216bb34c Shikhar Bhushan
    \rule{\textwidth}{1pt}%
27 216bb34c Shikhar Bhushan
    \ifsphinxpdfoutput
28 216bb34c Shikhar Bhushan
      \begingroup
29 216bb34c Shikhar Bhushan
      % This \def is required to deal with multi-line authors; it
30 216bb34c Shikhar Bhushan
      % changes \\ to ', ' (comma-space), making it pass muster for
31 216bb34c Shikhar Bhushan
      % generating document info in the PDF file.
32 216bb34c Shikhar Bhushan
      \def\\{, }
33 216bb34c Shikhar Bhushan
      \pdfinfo{
34 216bb34c Shikhar Bhushan
        /Author (\@author)
35 216bb34c Shikhar Bhushan
        /Title (\@title)
36 216bb34c Shikhar Bhushan
      }
37 216bb34c Shikhar Bhushan
      \endgroup
38 216bb34c Shikhar Bhushan
    \fi
39 216bb34c Shikhar Bhushan
    \begin{flushright}%
40 216bb34c Shikhar Bhushan
      \sphinxlogo%
41 216bb34c Shikhar Bhushan
      {\rm\Huge\py@HeaderFamily \@title \par}%
42 216bb34c Shikhar Bhushan
      {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par}
43 216bb34c Shikhar Bhushan
      \vfill
44 216bb34c Shikhar Bhushan
      {\LARGE\py@HeaderFamily \@author \par}
45 216bb34c Shikhar Bhushan
      \vfill\vfill
46 216bb34c Shikhar Bhushan
      {\large
47 216bb34c Shikhar Bhushan
       \@date \par
48 216bb34c Shikhar Bhushan
       \vfill
49 216bb34c Shikhar Bhushan
       \py@authoraddress \par
50 216bb34c Shikhar Bhushan
      }%
51 216bb34c Shikhar Bhushan
    \end{flushright}%\par
52 216bb34c Shikhar Bhushan
    \@thanks
53 216bb34c Shikhar Bhushan
  \end{titlepage}%
54 216bb34c Shikhar Bhushan
  \cleardoublepage%
55 216bb34c Shikhar Bhushan
  \setcounter{footnote}{0}%
56 216bb34c Shikhar Bhushan
  \let\thanks\relax\let\maketitle\relax
57 216bb34c Shikhar Bhushan
  %\gdef\@thanks{}\gdef\@author{}\gdef\@title{}
58 216bb34c Shikhar Bhushan
}
59 216bb34c Shikhar Bhushan
60 216bb34c Shikhar Bhushan
61 216bb34c Shikhar Bhushan
% Catch the end of the {abstract} environment, but here make sure the abstract
62 216bb34c Shikhar Bhushan
% is followed by a blank page if the 'openright' option is used.
63 216bb34c Shikhar Bhushan
%
64 216bb34c Shikhar Bhushan
\let\py@OldEndAbstract=\endabstract
65 216bb34c Shikhar Bhushan
\renewcommand{\endabstract}{
66 216bb34c Shikhar Bhushan
  \if@openright
67 216bb34c Shikhar Bhushan
    \ifodd\value{page}
68 216bb34c Shikhar Bhushan
      \typeout{Adding blank page after the abstract.}
69 216bb34c Shikhar Bhushan
      \vfil\pagebreak
70 216bb34c Shikhar Bhushan
    \fi
71 216bb34c Shikhar Bhushan
  \fi
72 216bb34c Shikhar Bhushan
  \py@OldEndAbstract
73 216bb34c Shikhar Bhushan
}
74 216bb34c Shikhar Bhushan
75 216bb34c Shikhar Bhushan
% This wraps the \tableofcontents macro with all the magic to get the spacing
76 216bb34c Shikhar Bhushan
% right and have the right number of pages if the 'openright' option has been
77 216bb34c Shikhar Bhushan
% used.  This eliminates a fair amount of crud in the individual document files.
78 216bb34c Shikhar Bhushan
%
79 216bb34c Shikhar Bhushan
\let\py@OldTableofcontents=\tableofcontents
80 216bb34c Shikhar Bhushan
\renewcommand{\tableofcontents}{%
81 216bb34c Shikhar Bhushan
  \setcounter{page}{1}%
82 216bb34c Shikhar Bhushan
  \pagebreak%
83 216bb34c Shikhar Bhushan
  \pagestyle{plain}%
84 216bb34c Shikhar Bhushan
  {%
85 216bb34c Shikhar Bhushan
    \parskip = 0mm%
86 216bb34c Shikhar Bhushan
    \py@OldTableofcontents%
87 216bb34c Shikhar Bhushan
    \if@openright%
88 216bb34c Shikhar Bhushan
      \ifodd\value{page}%
89 216bb34c Shikhar Bhushan
        \typeout{Adding blank page after the table of contents.}%
90 216bb34c Shikhar Bhushan
        \pagebreak\hspace{0pt}%
91 216bb34c Shikhar Bhushan
      \fi%
92 216bb34c Shikhar Bhushan
    \fi%
93 216bb34c Shikhar Bhushan
    \cleardoublepage%
94 216bb34c Shikhar Bhushan
  }%
95 216bb34c Shikhar Bhushan
  \pagenumbering{arabic}%
96 216bb34c Shikhar Bhushan
  \@ifundefined{fancyhf}{}{\pagestyle{normal}}%
97 216bb34c Shikhar Bhushan
}
98 216bb34c Shikhar Bhushan
99 216bb34c Shikhar Bhushan
% This is needed to get the width of the section # area wide enough in the
100 216bb34c Shikhar Bhushan
% library reference.  Doing it here keeps it the same for all the manuals.
101 216bb34c Shikhar Bhushan
%
102 216bb34c Shikhar Bhushan
\renewcommand*\l@section{\@dottedtocline{1}{1.5em}{2.6em}}
103 216bb34c Shikhar Bhushan
\renewcommand*\l@subsection{\@dottedtocline{2}{4.1em}{3.5em}}