annotate gcc/ada/doc/share/sphinx.sty @ 111:04ced10e8804

gcc 7
author kono
date Fri, 27 Oct 2017 22:46:09 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 %
kono
parents:
diff changeset
2 % sphinx.sty
kono
parents:
diff changeset
3 %
kono
parents:
diff changeset
4 % Adapted from the old python.sty, mostly written by Fred Drake,
kono
parents:
diff changeset
5 % by Georg Brandl.
kono
parents:
diff changeset
6 %
kono
parents:
diff changeset
7
kono
parents:
diff changeset
8 \NeedsTeXFormat{LaTeX2e}[1995/12/01]
kono
parents:
diff changeset
9 \ProvidesPackage{sphinx}[2010/01/15 LaTeX package (Sphinx markup)]
kono
parents:
diff changeset
10
kono
parents:
diff changeset
11 \@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}}
kono
parents:
diff changeset
12
kono
parents:
diff changeset
13 \RequirePackage{textcomp}
kono
parents:
diff changeset
14 \RequirePackage{fancybox}
kono
parents:
diff changeset
15 \RequirePackage{titlesec}
kono
parents:
diff changeset
16 \RequirePackage{tabulary}
kono
parents:
diff changeset
17 \RequirePackage{amsmath} % for \text
kono
parents:
diff changeset
18 \RequirePackage{makeidx}
kono
parents:
diff changeset
19 \RequirePackage{framed}
kono
parents:
diff changeset
20 \RequirePackage{ifthen}
kono
parents:
diff changeset
21 \RequirePackage{color}
kono
parents:
diff changeset
22 % For highlighted code.
kono
parents:
diff changeset
23 \RequirePackage{fancyvrb}
kono
parents:
diff changeset
24 % For table captions.
kono
parents:
diff changeset
25 \RequirePackage{threeparttable}
kono
parents:
diff changeset
26 % Handle footnotes in tables.
kono
parents:
diff changeset
27 \RequirePackage{footnote}
kono
parents:
diff changeset
28 \makesavenoteenv{tabulary}
kono
parents:
diff changeset
29 % For floating figures in the text.
kono
parents:
diff changeset
30 \RequirePackage{wrapfig}
kono
parents:
diff changeset
31 % Separate paragraphs by space by default.
kono
parents:
diff changeset
32 \RequirePackage{parskip}
kono
parents:
diff changeset
33 \RequirePackage{lastpage}
kono
parents:
diff changeset
34 % Redefine these colors to your liking in the preamble.
kono
parents:
diff changeset
35 \definecolor{TitleColor}{rgb}{0.126,0.263,0.361}
kono
parents:
diff changeset
36 \definecolor{InnerLinkColor}{rgb}{0.208,0.374,0.486}
kono
parents:
diff changeset
37 \definecolor{OuterLinkColor}{rgb}{0.216,0.439,0.388}
kono
parents:
diff changeset
38
kono
parents:
diff changeset
39 % Required to preserve indentation settings in minipage constructs
kono
parents:
diff changeset
40 % (otherwise parskip is set to 0 by default. minipagerestore is called
kono
parents:
diff changeset
41 % each time we enter a minipage environment)
kono
parents:
diff changeset
42 \newcommand{\@minipagerestore}{\setlength{\parskip}{\medskipamount}}
kono
parents:
diff changeset
43
kono
parents:
diff changeset
44 % Redefine these colors to something not white if you want to have colored
kono
parents:
diff changeset
45 % background and border for code examples.
kono
parents:
diff changeset
46 \definecolor{VerbatimColor}{rgb}{1,1,1}
kono
parents:
diff changeset
47 \definecolor{VerbatimBorderColor}{rgb}{1,1,1}
kono
parents:
diff changeset
48
kono
parents:
diff changeset
49 % Uncomment these two lines to ignore the paper size and make the page
kono
parents:
diff changeset
50 % size more like a typical published manual.
kono
parents:
diff changeset
51 %\renewcommand{\paperheight}{9in}
kono
parents:
diff changeset
52 %\renewcommand{\paperwidth}{8.5in} % typical squarish manual
kono
parents:
diff changeset
53 %\renewcommand{\paperwidth}{7in} % O'Reilly ``Programmming Python''
kono
parents:
diff changeset
54
kono
parents:
diff changeset
55 % use pdfoutput for pTeX and dvipdfmx
kono
parents:
diff changeset
56 \ifx\kanjiskip\undefined\else
kono
parents:
diff changeset
57 \ifx\Gin@driver{dvipdfmx.def}\undefined\else
kono
parents:
diff changeset
58 \newcount\pdfoutput\pdfoutput=0
kono
parents:
diff changeset
59 \fi
kono
parents:
diff changeset
60 \fi
kono
parents:
diff changeset
61
kono
parents:
diff changeset
62 % For graphicx, check if we are compiling under latex or pdflatex.
kono
parents:
diff changeset
63 \ifx\pdftexversion\undefined
kono
parents:
diff changeset
64 \usepackage{graphicx}
kono
parents:
diff changeset
65 \else
kono
parents:
diff changeset
66 \usepackage[pdftex]{graphicx}
kono
parents:
diff changeset
67 \fi
kono
parents:
diff changeset
68
kono
parents:
diff changeset
69 % for PDF output, use colors and maximal compression
kono
parents:
diff changeset
70 \newif\ifsphinxpdfoutput\sphinxpdfoutputfalse
kono
parents:
diff changeset
71 \ifx\pdfoutput\undefined\else\ifcase\pdfoutput
kono
parents:
diff changeset
72 \let\py@NormalColor\relax
kono
parents:
diff changeset
73 \let\py@TitleColor\relax
kono
parents:
diff changeset
74 \else
kono
parents:
diff changeset
75 \sphinxpdfoutputtrue
kono
parents:
diff changeset
76 \input{pdfcolor}
kono
parents:
diff changeset
77 \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
kono
parents:
diff changeset
78 \def\py@TitleColor{\color{TitleColor}}
kono
parents:
diff changeset
79 \pdfcompresslevel=9
kono
parents:
diff changeset
80 \fi\fi
kono
parents:
diff changeset
81
kono
parents:
diff changeset
82 % XeLaTeX can do colors, too
kono
parents:
diff changeset
83 \ifx\XeTeXrevision\undefined\else
kono
parents:
diff changeset
84 \def\py@NormalColor{\color[rgb]{0.0,0.0,0.0}}
kono
parents:
diff changeset
85 \def\py@TitleColor{\color{TitleColor}}
kono
parents:
diff changeset
86 \fi
kono
parents:
diff changeset
87
kono
parents:
diff changeset
88 % Increase printable page size (copied from fullpage.sty)
kono
parents:
diff changeset
89 \topmargin 0pt
kono
parents:
diff changeset
90 \advance \topmargin by -\headheight
kono
parents:
diff changeset
91 \advance \topmargin by -\headsep
kono
parents:
diff changeset
92
kono
parents:
diff changeset
93 % attempt to work a little better for A4 users
kono
parents:
diff changeset
94 \textheight \paperheight
kono
parents:
diff changeset
95 \advance\textheight by -2in
kono
parents:
diff changeset
96
kono
parents:
diff changeset
97 \oddsidemargin 0pt
kono
parents:
diff changeset
98 \evensidemargin 0pt
kono
parents:
diff changeset
99 %\evensidemargin -.25in % for ``manual size'' documents
kono
parents:
diff changeset
100 \marginparwidth 0.5in
kono
parents:
diff changeset
101
kono
parents:
diff changeset
102 \textwidth \paperwidth
kono
parents:
diff changeset
103 \advance\textwidth by -2in
kono
parents:
diff changeset
104
kono
parents:
diff changeset
105
kono
parents:
diff changeset
106 % Style parameters and macros used by most documents here
kono
parents:
diff changeset
107 \raggedbottom
kono
parents:
diff changeset
108 \sloppy
kono
parents:
diff changeset
109 \hbadness = 5000 % don't print trivial gripes
kono
parents:
diff changeset
110
kono
parents:
diff changeset
111 \pagestyle{empty} % start this way
kono
parents:
diff changeset
112
kono
parents:
diff changeset
113 \renewcommand{\maketitle}{%
kono
parents:
diff changeset
114 \begin{titlepage}%
kono
parents:
diff changeset
115 \let\footnotesize\small
kono
parents:
diff changeset
116 \let\footnoterule\relax
kono
parents:
diff changeset
117 \rule{\textwidth}{1pt}%
kono
parents:
diff changeset
118 \ifsphinxpdfoutput
kono
parents:
diff changeset
119 \begingroup
kono
parents:
diff changeset
120 % These \defs are required to deal with multi-line authors; it
kono
parents:
diff changeset
121 % changes \\ to ', ' (comma-space), making it pass muster for
kono
parents:
diff changeset
122 % generating document info in the PDF file.
kono
parents:
diff changeset
123 \def\\{, }
kono
parents:
diff changeset
124 \def\and{and }
kono
parents:
diff changeset
125 \pdfinfo{
kono
parents:
diff changeset
126 /Author (\@author)
kono
parents:
diff changeset
127 /Title (\@title)
kono
parents:
diff changeset
128 }
kono
parents:
diff changeset
129 \endgroup
kono
parents:
diff changeset
130 \fi
kono
parents:
diff changeset
131 \begin{flushright}%
kono
parents:
diff changeset
132 \sphinxlogo%
kono
parents:
diff changeset
133 {\rm\Huge \@title \par}%
kono
parents:
diff changeset
134 {\em\LARGE\py@HeaderFamily \py@release\releaseinfo \par}
kono
parents:
diff changeset
135 \vfill
kono
parents:
diff changeset
136 {\LARGE\py@HeaderFamily
kono
parents:
diff changeset
137 \par}
kono
parents:
diff changeset
138 \vfill\vfill
kono
parents:
diff changeset
139 {\large
kono
parents:
diff changeset
140 \@date \par
kono
parents:
diff changeset
141 \vfill
kono
parents:
diff changeset
142 \py@authoraddress \par
kono
parents:
diff changeset
143 }%
kono
parents:
diff changeset
144 \end{flushright}%\par
kono
parents:
diff changeset
145 \@thanks
kono
parents:
diff changeset
146 \end{titlepage}%
kono
parents:
diff changeset
147 \cleardoublepage%
kono
parents:
diff changeset
148 \setcounter{footnote}{0}%
kono
parents:
diff changeset
149 \let\thanks\relax\let\maketitle\relax
kono
parents:
diff changeset
150 }
kono
parents:
diff changeset
151
kono
parents:
diff changeset
152
kono
parents:
diff changeset
153 % Use this to set the font family for headers and other decor:
kono
parents:
diff changeset
154 \newcommand{\py@HeaderFamily}{\sffamily\bfseries}
kono
parents:
diff changeset
155
kono
parents:
diff changeset
156 % Redefine the 'normal' header/footer style when using "fancyhdr" package:
kono
parents:
diff changeset
157 \@ifundefined{fancyhf}{}{
kono
parents:
diff changeset
158 % Use \pagestyle{normal} as the primary pagestyle for text.
kono
parents:
diff changeset
159 \fancypagestyle{normal}{
kono
parents:
diff changeset
160 \fancyhf{}
kono
parents:
diff changeset
161 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage\ of \pageref*{LastPage}}}
kono
parents:
diff changeset
162 \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}
kono
parents:
diff changeset
163 \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}
kono
parents:
diff changeset
164 \fancyhead[LE,RO]{{\py@HeaderFamily \@title, \py@release}}
kono
parents:
diff changeset
165 \renewcommand{\headrulewidth}{0.4pt}
kono
parents:
diff changeset
166 \renewcommand{\footrulewidth}{0.4pt}
kono
parents:
diff changeset
167 % define chaptermark with \@chappos when \@chappos is available for Japanese
kono
parents:
diff changeset
168 \ifx\@chappos\undefined\else
kono
parents:
diff changeset
169 \def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}
kono
parents:
diff changeset
170 \fi
kono
parents:
diff changeset
171 }
kono
parents:
diff changeset
172 % Update the plain style so we get the page number & footer line,
kono
parents:
diff changeset
173 % but not a chapter or section title. This is to keep the first
kono
parents:
diff changeset
174 % page of a chapter and the blank page between chapters `clean.'
kono
parents:
diff changeset
175 \fancypagestyle{plain}{
kono
parents:
diff changeset
176 \fancyhf{}
kono
parents:
diff changeset
177 \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage\ of \pageref*{LastPage}}}
kono
parents:
diff changeset
178 \fancyfoot[LO,RE]{{\py@HeaderFamily \GNATFullDocumentName}}
kono
parents:
diff changeset
179 \fancyhead[LE,RO]{{\py@HeaderFamily \@title\ \GNATVersion}}
kono
parents:
diff changeset
180 \renewcommand{\headrulewidth}{0.0pt}
kono
parents:
diff changeset
181 \renewcommand{\footrulewidth}{0.4pt}
kono
parents:
diff changeset
182 }
kono
parents:
diff changeset
183 }
kono
parents:
diff changeset
184
kono
parents:
diff changeset
185 % Some custom font markup commands.
kono
parents:
diff changeset
186 %
kono
parents:
diff changeset
187 \newcommand{\strong}[1]{{\textbf{#1}}}
kono
parents:
diff changeset
188 \newcommand{\code}[1]{\texttt{#1}}
kono
parents:
diff changeset
189 \newcommand{\bfcode}[1]{\code{\bfseries#1}}
kono
parents:
diff changeset
190 \newcommand{\email}[1]{\textsf{#1}}
kono
parents:
diff changeset
191
kono
parents:
diff changeset
192 % Redefine the Verbatim environment to allow border and background colors.
kono
parents:
diff changeset
193 % The original environment is still used for verbatims within tables.
kono
parents:
diff changeset
194 \let\OriginalVerbatim=\Verbatim
kono
parents:
diff changeset
195 \let\endOriginalVerbatim=\endVerbatim
kono
parents:
diff changeset
196
kono
parents:
diff changeset
197 % Play with vspace to be able to keep the indentation.
kono
parents:
diff changeset
198 \newlength\distancetoright
kono
parents:
diff changeset
199 \def\mycolorbox#1{%
kono
parents:
diff changeset
200 \setlength\distancetoright{\linewidth}%
kono
parents:
diff changeset
201 \advance\distancetoright -\@totalleftmargin %
kono
parents:
diff changeset
202 \fcolorbox{VerbatimBorderColor}{VerbatimColor}{%
kono
parents:
diff changeset
203 \begin{minipage}{\distancetoright}%
kono
parents:
diff changeset
204 #1
kono
parents:
diff changeset
205 \end{minipage}%
kono
parents:
diff changeset
206 }%
kono
parents:
diff changeset
207 }
kono
parents:
diff changeset
208 \def\FrameCommand{\mycolorbox}
kono
parents:
diff changeset
209
kono
parents:
diff changeset
210 \renewcommand{\Verbatim}[1][1]{%
kono
parents:
diff changeset
211 % list starts new par, but we don't want it to be set apart vertically
kono
parents:
diff changeset
212 \bgroup\parskip=0pt%
kono
parents:
diff changeset
213 \smallskip%
kono
parents:
diff changeset
214 % The list environement is needed to control perfectly the vertical
kono
parents:
diff changeset
215 % space.
kono
parents:
diff changeset
216 \list{}{%
kono
parents:
diff changeset
217 \setlength\parskip{0pt}%
kono
parents:
diff changeset
218 \setlength\itemsep{0ex}%
kono
parents:
diff changeset
219 \setlength\topsep{0ex}%
kono
parents:
diff changeset
220 \setlength\partopsep{0pt}%
kono
parents:
diff changeset
221 \setlength\leftmargin{0pt}%
kono
parents:
diff changeset
222 }%
kono
parents:
diff changeset
223 \item\MakeFramed {\FrameRestore}%
kono
parents:
diff changeset
224 \small%
kono
parents:
diff changeset
225 \OriginalVerbatim[#1]%
kono
parents:
diff changeset
226 }
kono
parents:
diff changeset
227 \renewcommand{\endVerbatim}{%
kono
parents:
diff changeset
228 \endOriginalVerbatim%
kono
parents:
diff changeset
229 \endMakeFramed%
kono
parents:
diff changeset
230 \endlist%
kono
parents:
diff changeset
231 % close group to restore \parskip
kono
parents:
diff changeset
232 \egroup%
kono
parents:
diff changeset
233 }
kono
parents:
diff changeset
234
kono
parents:
diff changeset
235
kono
parents:
diff changeset
236 % \moduleauthor{name}{email}
kono
parents:
diff changeset
237 \newcommand{\moduleauthor}[2]{}
kono
parents:
diff changeset
238
kono
parents:
diff changeset
239 % \sectionauthor{name}{email}
kono
parents:
diff changeset
240 \newcommand{\sectionauthor}[2]{}
kono
parents:
diff changeset
241
kono
parents:
diff changeset
242 % Augment the sectioning commands used to get our own font family in place,
kono
parents:
diff changeset
243 % and reset some internal data items:
kono
parents:
diff changeset
244 \titleformat{\section}{\Large\py@HeaderFamily}%
kono
parents:
diff changeset
245 {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}
kono
parents:
diff changeset
246 \titleformat{\subsection}{\large\py@HeaderFamily}%
kono
parents:
diff changeset
247 {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
kono
parents:
diff changeset
248 \titleformat{\subsubsection}{\py@HeaderFamily}%
kono
parents:
diff changeset
249 {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}
kono
parents:
diff changeset
250 \titleformat{\paragraph}{\small\py@HeaderFamily}%
kono
parents:
diff changeset
251 {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor}
kono
parents:
diff changeset
252
kono
parents:
diff changeset
253 % {fulllineitems} is the main environment for object descriptions.
kono
parents:
diff changeset
254 %
kono
parents:
diff changeset
255 \newcommand{\py@itemnewline}[1]{%
kono
parents:
diff changeset
256 \@tempdima\linewidth%
kono
parents:
diff changeset
257 \advance\@tempdima \leftmargin\makebox[\@tempdima][l]{#1}%
kono
parents:
diff changeset
258 }
kono
parents:
diff changeset
259
kono
parents:
diff changeset
260 \newenvironment{fulllineitems}{
kono
parents:
diff changeset
261 \begin{list}{}{\labelwidth \leftmargin \labelsep 0pt
kono
parents:
diff changeset
262 \rightmargin 0pt \topsep -\parskip \partopsep \parskip
kono
parents:
diff changeset
263 \itemsep -\parsep
kono
parents:
diff changeset
264 \let\makelabel=\py@itemnewline}
kono
parents:
diff changeset
265 }{\end{list}}
kono
parents:
diff changeset
266
kono
parents:
diff changeset
267 % \optional is used for ``[, arg]``, i.e. desc_optional nodes.
kono
parents:
diff changeset
268 \newcommand{\optional}[1]{%
kono
parents:
diff changeset
269 {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}
kono
parents:
diff changeset
270
kono
parents:
diff changeset
271 \newlength{\py@argswidth}
kono
parents:
diff changeset
272 \newcommand{\py@sigparams}[2]{%
kono
parents:
diff changeset
273 \parbox[t]{\py@argswidth}{#1\code{)}#2}}
kono
parents:
diff changeset
274 \newcommand{\pysigline}[1]{\item[#1]\nopagebreak}
kono
parents:
diff changeset
275 \newcommand{\pysiglinewithargsret}[3]{%
kono
parents:
diff changeset
276 \settowidth{\py@argswidth}{#1\code{(}}%
kono
parents:
diff changeset
277 \addtolength{\py@argswidth}{-2\py@argswidth}%
kono
parents:
diff changeset
278 \addtolength{\py@argswidth}{\linewidth}%
kono
parents:
diff changeset
279 \item[#1\code{(}\py@sigparams{#2}{#3}]}
kono
parents:
diff changeset
280
kono
parents:
diff changeset
281 % Production lists
kono
parents:
diff changeset
282 %
kono
parents:
diff changeset
283 \newenvironment{productionlist}{
kono
parents:
diff changeset
284 % \def\optional##1{{\Large[}##1{\Large]}}
kono
parents:
diff changeset
285 \def\production##1##2{\\\code{##1}&::=&\code{##2}}
kono
parents:
diff changeset
286 \def\productioncont##1{\\& &\code{##1}}
kono
parents:
diff changeset
287 \parindent=2em
kono
parents:
diff changeset
288 \indent
kono
parents:
diff changeset
289 \begin{tabular}{lcl}
kono
parents:
diff changeset
290 }{%
kono
parents:
diff changeset
291 \end{tabular}
kono
parents:
diff changeset
292 }
kono
parents:
diff changeset
293
kono
parents:
diff changeset
294 % Notices / Admonitions
kono
parents:
diff changeset
295 %
kono
parents:
diff changeset
296 \newlength{\py@noticelength}
kono
parents:
diff changeset
297
kono
parents:
diff changeset
298 \newcommand{\py@heavybox}{
kono
parents:
diff changeset
299 \setlength{\fboxrule}{1pt}
kono
parents:
diff changeset
300 \setlength{\fboxsep}{6pt}
kono
parents:
diff changeset
301 \setlength{\py@noticelength}{\linewidth}
kono
parents:
diff changeset
302 \addtolength{\py@noticelength}{-2\fboxsep}
kono
parents:
diff changeset
303 \addtolength{\py@noticelength}{-2\fboxrule}
kono
parents:
diff changeset
304 %\setlength{\shadowsize}{3pt}
kono
parents:
diff changeset
305 \noindent\Sbox
kono
parents:
diff changeset
306 \minipage{\py@noticelength}
kono
parents:
diff changeset
307 }
kono
parents:
diff changeset
308 \newcommand{\py@endheavybox}{
kono
parents:
diff changeset
309 \endminipage
kono
parents:
diff changeset
310 \endSbox
kono
parents:
diff changeset
311 \fbox{\TheSbox}
kono
parents:
diff changeset
312 }
kono
parents:
diff changeset
313
kono
parents:
diff changeset
314 \newcommand{\py@lightbox}{{%
kono
parents:
diff changeset
315 \setlength\parskip{0pt}\par
kono
parents:
diff changeset
316 \noindent\rule[0ex]{\linewidth}{0.5pt}%
kono
parents:
diff changeset
317 \par\noindent\vspace{-0.5ex}%
kono
parents:
diff changeset
318 }}
kono
parents:
diff changeset
319 \newcommand{\py@endlightbox}{{%
kono
parents:
diff changeset
320 \setlength{\parskip}{0pt}%
kono
parents:
diff changeset
321 \par\noindent\rule[0.5ex]{\linewidth}{0.5pt}%
kono
parents:
diff changeset
322 \par\vspace{-0.5ex}%
kono
parents:
diff changeset
323 }}
kono
parents:
diff changeset
324
kono
parents:
diff changeset
325
kono
parents:
diff changeset
326
kono
parents:
diff changeset
327 % Some are quite plain:
kono
parents:
diff changeset
328 \newcommand{\py@noticestart@note}{\py@lightbox}
kono
parents:
diff changeset
329 \newcommand{\py@noticeend@note}{\py@endlightbox}
kono
parents:
diff changeset
330 \newcommand{\py@noticestart@hint}{\py@lightbox}
kono
parents:
diff changeset
331 \newcommand{\py@noticeend@hint}{\py@endlightbox}
kono
parents:
diff changeset
332 \newcommand{\py@noticestart@important}{\py@lightbox}
kono
parents:
diff changeset
333 \newcommand{\py@noticeend@important}{\py@endlightbox}
kono
parents:
diff changeset
334 \newcommand{\py@noticestart@tip}{\py@lightbox}
kono
parents:
diff changeset
335 \newcommand{\py@noticeend@tip}{\py@endlightbox}
kono
parents:
diff changeset
336
kono
parents:
diff changeset
337 % Others gets more visible distinction:
kono
parents:
diff changeset
338 \newcommand{\py@noticestart@warning}{\py@heavybox}
kono
parents:
diff changeset
339 \newcommand{\py@noticeend@warning}{\py@endheavybox}
kono
parents:
diff changeset
340 \newcommand{\py@noticestart@caution}{\py@heavybox}
kono
parents:
diff changeset
341 \newcommand{\py@noticeend@caution}{\py@endheavybox}
kono
parents:
diff changeset
342 \newcommand{\py@noticestart@attention}{\py@heavybox}
kono
parents:
diff changeset
343 \newcommand{\py@noticeend@attention}{\py@endheavybox}
kono
parents:
diff changeset
344 \newcommand{\py@noticestart@danger}{\py@heavybox}
kono
parents:
diff changeset
345 \newcommand{\py@noticeend@danger}{\py@endheavybox}
kono
parents:
diff changeset
346 \newcommand{\py@noticestart@error}{\py@heavybox}
kono
parents:
diff changeset
347 \newcommand{\py@noticeend@error}{\py@endheavybox}
kono
parents:
diff changeset
348
kono
parents:
diff changeset
349 \newenvironment{notice}[2]{
kono
parents:
diff changeset
350 \def\py@noticetype{#1}
kono
parents:
diff changeset
351 \csname py@noticestart@#1\endcsname
kono
parents:
diff changeset
352 \strong{#2}
kono
parents:
diff changeset
353 }{\csname py@noticeend@\py@noticetype\endcsname}
kono
parents:
diff changeset
354
kono
parents:
diff changeset
355 % Allow the release number to be specified independently of the
kono
parents:
diff changeset
356 % \date{}. This allows the date to reflect the document's date and
kono
parents:
diff changeset
357 % release to specify the release that is documented.
kono
parents:
diff changeset
358 %
kono
parents:
diff changeset
359 \newcommand{\py@release}{}
kono
parents:
diff changeset
360 \newcommand{\version}{}
kono
parents:
diff changeset
361 \newcommand{\shortversion}{}
kono
parents:
diff changeset
362 \newcommand{\releaseinfo}{}
kono
parents:
diff changeset
363 \newcommand{\releasename}{GNAT}
kono
parents:
diff changeset
364 \newcommand{\release}[1]{%
kono
parents:
diff changeset
365 \renewcommand{\py@release}{\releasename\space\version}%
kono
parents:
diff changeset
366 \renewcommand{\version}{#1}}
kono
parents:
diff changeset
367 \newcommand{\setshortversion}[1]{%
kono
parents:
diff changeset
368 \renewcommand{\shortversion}{#1}}
kono
parents:
diff changeset
369 \newcommand{\setreleaseinfo}[1]{%
kono
parents:
diff changeset
370 \renewcommand{\releaseinfo}{#1}}
kono
parents:
diff changeset
371
kono
parents:
diff changeset
372 % Allow specification of the author's address separately from the
kono
parents:
diff changeset
373 % author's name. This can be used to format them differently, which
kono
parents:
diff changeset
374 % is a good thing.
kono
parents:
diff changeset
375 %
kono
parents:
diff changeset
376 \newcommand{\py@authoraddress}{}
kono
parents:
diff changeset
377 \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}
kono
parents:
diff changeset
378
kono
parents:
diff changeset
379 % This sets up the fancy chapter headings that make the documents look
kono
parents:
diff changeset
380 % at least a little better than the usual LaTeX output.
kono
parents:
diff changeset
381 %
kono
parents:
diff changeset
382 \@ifundefined{ChTitleVar}{}{
kono
parents:
diff changeset
383 \ChNameVar{\raggedleft\normalsize\py@HeaderFamily}
kono
parents:
diff changeset
384 \ChNumVar{\raggedleft \bfseries\Large\py@HeaderFamily}
kono
parents:
diff changeset
385 \ChTitleVar{\raggedleft \textrm{\Huge\py@HeaderFamily}}
kono
parents:
diff changeset
386 % This creates chapter heads without the leading \vspace*{}:
kono
parents:
diff changeset
387 \def\@makechapterhead#1{%
kono
parents:
diff changeset
388 {\parindent \z@ \raggedright \normalfont
kono
parents:
diff changeset
389 \ifnum \c@secnumdepth >\m@ne
kono
parents:
diff changeset
390 \DOCH
kono
parents:
diff changeset
391 \fi
kono
parents:
diff changeset
392 \interlinepenalty\@M
kono
parents:
diff changeset
393 \DOTI{#1}
kono
parents:
diff changeset
394 }
kono
parents:
diff changeset
395 }
kono
parents:
diff changeset
396 }
kono
parents:
diff changeset
397
kono
parents:
diff changeset
398 % Redefine description environment so that it is usable inside fulllineitems.
kono
parents:
diff changeset
399 %
kono
parents:
diff changeset
400 \renewcommand{\description}{%
kono
parents:
diff changeset
401 \list{}{\labelwidth\z@%
kono
parents:
diff changeset
402 \itemindent-\leftmargin%
kono
parents:
diff changeset
403 \labelsep5pt%
kono
parents:
diff changeset
404 \let\makelabel=\descriptionlabel}}
kono
parents:
diff changeset
405
kono
parents:
diff changeset
406 % Definition lists; requested by AMK for HOWTO documents. Probably useful
kono
parents:
diff changeset
407 % elsewhere as well, so keep in in the general style support.
kono
parents:
diff changeset
408 %
kono
parents:
diff changeset
409 \newenvironment{definitions}{%
kono
parents:
diff changeset
410 \begin{description}%
kono
parents:
diff changeset
411 \def\term##1{\item[##1]\mbox{}\\*[0mm]}
kono
parents:
diff changeset
412 }{%
kono
parents:
diff changeset
413 \end{description}%
kono
parents:
diff changeset
414 }
kono
parents:
diff changeset
415
kono
parents:
diff changeset
416 % Tell TeX about pathological hyphenation cases:
kono
parents:
diff changeset
417 \hyphenation{Base-HTTP-Re-quest-Hand-ler}
kono
parents:
diff changeset
418
kono
parents:
diff changeset
419
kono
parents:
diff changeset
420 % The following is stuff copied from docutils' latex writer.
kono
parents:
diff changeset
421 %
kono
parents:
diff changeset
422 \newcommand{\optionlistlabel}[1]{\bf #1 \hfill}
kono
parents:
diff changeset
423 \newenvironment{optionlist}[1]
kono
parents:
diff changeset
424 {\begin{list}{}
kono
parents:
diff changeset
425 {\setlength{\labelwidth}{#1}
kono
parents:
diff changeset
426 \setlength{\rightmargin}{1cm}
kono
parents:
diff changeset
427 \setlength{\leftmargin}{\rightmargin}
kono
parents:
diff changeset
428 \addtolength{\leftmargin}{\labelwidth}
kono
parents:
diff changeset
429 \addtolength{\leftmargin}{\labelsep}
kono
parents:
diff changeset
430 \renewcommand{\makelabel}{\optionlistlabel}}
kono
parents:
diff changeset
431 }{\end{list}}
kono
parents:
diff changeset
432
kono
parents:
diff changeset
433 \newlength{\lineblockindentation}
kono
parents:
diff changeset
434 \setlength{\lineblockindentation}{2.5em}
kono
parents:
diff changeset
435 \newenvironment{lineblock}[1]
kono
parents:
diff changeset
436 {\begin{list}{}
kono
parents:
diff changeset
437 {\setlength{\partopsep}{\parskip}
kono
parents:
diff changeset
438 \addtolength{\partopsep}{\baselineskip}
kono
parents:
diff changeset
439 \topsep0pt\itemsep0.15\baselineskip\parsep0pt
kono
parents:
diff changeset
440 \leftmargin#1}
kono
parents:
diff changeset
441 \raggedright}
kono
parents:
diff changeset
442 {\end{list}}
kono
parents:
diff changeset
443
kono
parents:
diff changeset
444 % Redefine includgraphics for avoiding images larger than the screen size
kono
parents:
diff changeset
445 % If the size is not specified.
kono
parents:
diff changeset
446 \let\py@Oldincludegraphics\includegraphics
kono
parents:
diff changeset
447
kono
parents:
diff changeset
448 \newbox\image@box%
kono
parents:
diff changeset
449 \newdimen\image@width%
kono
parents:
diff changeset
450 \renewcommand\includegraphics[2][\@empty]{%
kono
parents:
diff changeset
451 \ifx#1\@empty%
kono
parents:
diff changeset
452 \setbox\image@box=\hbox{\py@Oldincludegraphics{#2}}%
kono
parents:
diff changeset
453 \image@width\wd\image@box%
kono
parents:
diff changeset
454 \ifdim \image@width>\linewidth%
kono
parents:
diff changeset
455 \setbox\image@box=\hbox{\py@Oldincludegraphics[width=\linewidth]{#2}}%
kono
parents:
diff changeset
456 \box\image@box%
kono
parents:
diff changeset
457 \else%
kono
parents:
diff changeset
458 \py@Oldincludegraphics{#2}%
kono
parents:
diff changeset
459 \fi%
kono
parents:
diff changeset
460 \else%
kono
parents:
diff changeset
461 \py@Oldincludegraphics[#1]{#2}%
kono
parents:
diff changeset
462 \fi%
kono
parents:
diff changeset
463 }
kono
parents:
diff changeset
464
kono
parents:
diff changeset
465 % to make pdf with correct encoded bookmarks in Japanese
kono
parents:
diff changeset
466 % this should precede the hyperref package
kono
parents:
diff changeset
467 \ifx\kanjiskip\undefined\else
kono
parents:
diff changeset
468 \usepackage{atbegshi}
kono
parents:
diff changeset
469 \ifx\ucs\undefined
kono
parents:
diff changeset
470 \ifnum 42146=\euc"A4A2
kono
parents:
diff changeset
471 \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}
kono
parents:
diff changeset
472 \else
kono
parents:
diff changeset
473 \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}
kono
parents:
diff changeset
474 \fi
kono
parents:
diff changeset
475 \else
kono
parents:
diff changeset
476 \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}
kono
parents:
diff changeset
477 \fi
kono
parents:
diff changeset
478 \fi
kono
parents:
diff changeset
479
kono
parents:
diff changeset
480 % Include hyperref last.
kono
parents:
diff changeset
481 \RequirePackage[colorlinks,breaklinks,destlabel,
kono
parents:
diff changeset
482 linkcolor=InnerLinkColor,filecolor=OuterLinkColor,
kono
parents:
diff changeset
483 menucolor=OuterLinkColor,urlcolor=OuterLinkColor,
kono
parents:
diff changeset
484 citecolor=InnerLinkColor]{hyperref}
kono
parents:
diff changeset
485 % Fix anchor placement for figures with captions.
kono
parents:
diff changeset
486 % (Note: we don't use a package option here; instead, we give an explicit
kono
parents:
diff changeset
487 % \capstart for figures that actually have a caption.)
kono
parents:
diff changeset
488 \RequirePackage{hypcap}
kono
parents:
diff changeset
489
kono
parents:
diff changeset
490 % From docutils.writers.latex2e
kono
parents:
diff changeset
491 \providecommand{\DUspan}[2]{%
kono
parents:
diff changeset
492 {% group ("span") to limit the scope of styling commands
kono
parents:
diff changeset
493 \@for\node@class@name:=#1\do{%
kono
parents:
diff changeset
494 \ifcsname docutilsrole\node@class@name\endcsname%
kono
parents:
diff changeset
495 \csname docutilsrole\node@class@name\endcsname%
kono
parents:
diff changeset
496 \fi%
kono
parents:
diff changeset
497 }%
kono
parents:
diff changeset
498 {#2}% node content
kono
parents:
diff changeset
499 }% close "span"
kono
parents:
diff changeset
500 }
kono
parents:
diff changeset
501
kono
parents:
diff changeset
502 \providecommand*{\DUprovidelength}[2]{
kono
parents:
diff changeset
503 \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{}
kono
parents:
diff changeset
504 }
kono
parents:
diff changeset
505
kono
parents:
diff changeset
506 \DUprovidelength{\DUlineblockindent}{2.5em}
kono
parents:
diff changeset
507 \ifthenelse{\isundefined{\DUlineblock}}{
kono
parents:
diff changeset
508 \newenvironment{DUlineblock}[1]{%
kono
parents:
diff changeset
509 \list{}{\setlength{\partopsep}{\parskip}
kono
parents:
diff changeset
510 \addtolength{\partopsep}{\baselineskip}
kono
parents:
diff changeset
511 \setlength{\topsep}{0pt}
kono
parents:
diff changeset
512 \setlength{\itemsep}{0.15\baselineskip}
kono
parents:
diff changeset
513 \setlength{\parsep}{0pt}
kono
parents:
diff changeset
514 \setlength{\leftmargin}{#1}}
kono
parents:
diff changeset
515 \raggedright
kono
parents:
diff changeset
516 }
kono
parents:
diff changeset
517 {\endlist}
kono
parents:
diff changeset
518 }{}
kono
parents:
diff changeset
519
kono
parents:
diff changeset
520
kono
parents:
diff changeset
521 % From footmisc.sty: allows footnotes in titles
kono
parents:
diff changeset
522 \let\FN@sf@@footnote\footnote
kono
parents:
diff changeset
523 \def\footnote{\ifx\protect\@typeset@protect
kono
parents:
diff changeset
524 \expandafter\FN@sf@@footnote
kono
parents:
diff changeset
525 \else
kono
parents:
diff changeset
526 \expandafter\FN@sf@gobble@opt
kono
parents:
diff changeset
527 \fi
kono
parents:
diff changeset
528 }
kono
parents:
diff changeset
529 \edef\FN@sf@gobble@opt{\noexpand\protect
kono
parents:
diff changeset
530 \expandafter\noexpand\csname FN@sf@gobble@opt \endcsname}
kono
parents:
diff changeset
531 \expandafter\def\csname FN@sf@gobble@opt \endcsname{%
kono
parents:
diff changeset
532 \@ifnextchar[%]
kono
parents:
diff changeset
533 \FN@sf@gobble@twobracket
kono
parents:
diff changeset
534 \@gobble
kono
parents:
diff changeset
535 }
kono
parents:
diff changeset
536 \def\FN@sf@gobble@twobracket[#1]#2{}
kono
parents:
diff changeset
537
kono
parents:
diff changeset
538 % adjust the margins for footer,
kono
parents:
diff changeset
539 % this works with the jsclasses only (Japanese standard document classes)
kono
parents:
diff changeset
540 \ifx\@jsc@uplatextrue\undefined\else
kono
parents:
diff changeset
541 \hypersetup{setpagesize=false}
kono
parents:
diff changeset
542 \setlength\footskip{2\baselineskip}
kono
parents:
diff changeset
543 \addtolength{\textheight}{-2\baselineskip}
kono
parents:
diff changeset
544 \fi
kono
parents:
diff changeset
545
kono
parents:
diff changeset
546 % fix the double index and bibliography on the table of contents
kono
parents:
diff changeset
547 % in jsclasses (Japanese standard document classes)
kono
parents:
diff changeset
548 \ifx\@jsc@uplatextrue\undefined\else
kono
parents:
diff changeset
549 \renewcommand{\theindex}{
kono
parents:
diff changeset
550 \cleardoublepage
kono
parents:
diff changeset
551 \phantomsection
kono
parents:
diff changeset
552 \py@OldTheindex
kono
parents:
diff changeset
553 }
kono
parents:
diff changeset
554 \renewcommand{\thebibliography}[1]{
kono
parents:
diff changeset
555 \cleardoublepage
kono
parents:
diff changeset
556 \phantomsection
kono
parents:
diff changeset
557 \py@OldThebibliography{1}
kono
parents:
diff changeset
558 }
kono
parents:
diff changeset
559 \fi
kono
parents:
diff changeset
560
kono
parents:
diff changeset
561 % do not use \@chappos in Appendix in pTeX
kono
parents:
diff changeset
562 \ifx\kanjiskip\undefined\else
kono
parents:
diff changeset
563 \renewcommand{\appendix}{\par
kono
parents:
diff changeset
564 \setcounter{chapter}{0}
kono
parents:
diff changeset
565 \setcounter{section}{0}
kono
parents:
diff changeset
566 \gdef\@chapapp{\appendixname}
kono
parents:
diff changeset
567 \gdef\@chappos{}
kono
parents:
diff changeset
568 \gdef\thechapter{\@Alph\c@chapter}
kono
parents:
diff changeset
569 }
kono
parents:
diff changeset
570 \fi