OpenI
/
graphkit-learn
Not watched
1
0
Fork 0
Code
Releases 2 Wiki Activity
Issues 0 Pull Requests 0 Datasets Model Cloudbrain
You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
Tree: 461de387b6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '461de387b6'
${ noResults }
graphkit-learn/docs/_build/latex/sphinx.sty

1685 lines
69 kB
Raw Blame History 

  1. %

  2. % sphinx.sty

  3. %

  4. % Adapted from the old python.sty, mostly written by Fred Drake,

  5. % by Georg Brandl.

  6. %

  7. 

  8. \NeedsTeXFormat{LaTeX2e}[1995/12/01]

  9. \ProvidesPackage{sphinx}[2018/07/18 v1.8 LaTeX package (Sphinx markup)]

  10. 

  11. % provides \ltx@ifundefined

  12. % (many packages load ltxcmds: graphicx does for pdftex and lualatex but

  13. % not xelatex, and anyhow kvoptions does, but it may be needed in future to

  14. % use \sphinxdeprecationwarning earlier, and it needs \ltx@ifundefined)

  15. \RequirePackage{ltxcmds}

  16. 

  17. %% for deprecation warnings

  18. \newcommand\sphinxdeprecationwarning[4]{% #1 the deprecated macro or name,

  19. % #2 = when deprecated, #3 = when removed, #4 = additional info

  20.   \edef\spx@tempa{\detokenize{#1}}%

  21.   \ltx@ifundefined{sphinx_depr_\spx@tempa}{%

  22.      \global\expandafter\let\csname sphinx_depr_\spx@tempa\endcsname\spx@tempa

  23.      \expandafter\AtEndDocument\expandafter{\expandafter\let\expandafter

  24.          \sphinxdeprecatedmacro\csname sphinx_depr_\spx@tempa\endcsname

  25.          \PackageWarningNoLine{sphinx}{^^J**** SPHINX DEPRECATION WARNING:^^J

  26.          \sphinxdeprecatedmacro^^J

  27.          \@spaces- is deprecated at Sphinx #2^^J

  28.          \@spaces- and removed at Sphinx #3.^^J

  29.          #4^^J****}}%

  30.   }{% warning already emitted (at end of latex log), don't repeat

  31.   }}

  32. 

  33. 

  34. %% PACKAGES

  35. %

  36. % we delay handling of options to after having loaded packages, because

  37. % of the need to use \definecolor.

  38. \RequirePackage{graphicx}

  39. \@ifclassloaded{memoir}{}{\RequirePackage{fancyhdr}}

  40. % for \text macro and \iffirstchoice@ conditional even if amsmath not loaded

  41. \RequirePackage{amstext}

  42. \RequirePackage{textcomp}% "warn" option issued from template

  43. \RequirePackage{titlesec}

  44. \@ifpackagelater{titlesec}{2016/03/15}%

  45.  {\@ifpackagelater{titlesec}{2016/03/21}%

  46.   {}%

  47.   {\newif\ifsphinx@ttlpatch@ok

  48.    \IfFileExists{etoolbox.sty}{%

  49.      \RequirePackage{etoolbox}%

  50.      \patchcmd{\ttlh@hang}{\parindent\z@}{\parindent\z@\leavevmode}%

  51.                                 {\sphinx@ttlpatch@oktrue}{}%

  52.      \ifsphinx@ttlpatch@ok

  53.      \patchcmd{\ttlh@hang}{\noindent}{}{}{\sphinx@ttlpatch@okfalse}%

  54.      \fi

  55.    }{}%

  56.    \ifsphinx@ttlpatch@ok

  57.      \typeout{^^J Package Sphinx Info: ^^J

  58.               **** titlesec 2.10.1 successfully patched for bugfix ****^^J}%

  59.    \else

  60.      \AtEndDocument{\PackageWarningNoLine{sphinx}{^^J%

  61. ******** titlesec 2.10.1 has a bug, (section numbers disappear) ......|^^J%

  62. ******** and Sphinx could not patch it, perhaps because your local ...|^^J%

  63. ******** copy is already fixed without a changed release date. .......|^^J%

  64. ******** If not, you must update titlesec! ...........................|}}%

  65.    \fi

  66.   }%

  67.  }{}

  68. \RequirePackage{tabulary}

  69. % tabulary has a bug with its re-definition of \multicolumn in its first pass

  70. % which is not \long. But now Sphinx does not use LaTeX's \multicolumn but its

  71. % own macro. Hence we don't even need to patch tabulary. See sphinxmulticell.sty

  72. % X or S (Sphinx) may have meanings if some table package is loaded hence

  73. % \X was chosen to avoid possibility of conflict

  74. \newcolumntype{\X}[2]{p{\dimexpr

  75.       (\linewidth-\arrayrulewidth)*#1/#2-\tw@\tabcolsep-\arrayrulewidth\relax}}

  76. \newcolumntype{\Y}[1]{p{\dimexpr

  77.       #1\dimexpr\linewidth-\arrayrulewidth\relax-\tw@\tabcolsep-\arrayrulewidth\relax}}

  78. % using here T (for Tabulary) feels less of a problem than the X could be

  79. \newcolumntype{T}{J}%

  80. % For tables allowing pagebreaks

  81. \RequirePackage{longtable}

  82. % User interface to set-up whitespace before and after tables:

  83. \newcommand*\sphinxtablepre {0pt}%

  84. \newcommand*\sphinxtablepost{\medskipamount}%

  85. \newcommand*\sphinxbelowcaptionspace{.5\sphinxbaselineskip}%

  86. % as one can not use \baselineskip from inside longtable (it is zero there)

  87. % we need \sphinxbaselineskip, which defaults to \baselineskip

  88. \def\sphinxbaselineskip{\baselineskip}%

  89. % These commands are inserted by the table templates

  90. \def\sphinxatlongtablestart

  91.    {\par

  92.     \vskip\parskip

  93.     \vskip\dimexpr\sphinxtablepre\relax % adjust vertical position

  94.     \vbox{}% get correct baseline from above

  95.     \LTpre\z@skip\LTpost\z@skip % set to zero longtable's own skips

  96.     \edef\sphinxbaselineskip{\dimexpr\the\dimexpr\baselineskip\relax\relax}%

  97.    }%

  98. \def\sphinxatlongtableend{\prevdepth\z@\vskip\sphinxtablepost\relax}%

  99. \def\sphinxlongtablecapskipadjust

  100.    {\dimexpr-\dp\strutbox-\sphinxbaselineskip+\sphinxbelowcaptionspace\relax}%

  101. % Now for tables not using longtable

  102. \def\sphinxattablestart

  103.    {\par

  104.     \vskip\dimexpr\sphinxtablepre\relax

  105.    }%

  106. \let\sphinxattableend\sphinxatlongtableend

  107. % longtable's wraps captions to a maximal width of \LTcapwidth

  108. % so we do the same for all tables

  109. \newcommand*\sphinxcapstartof[1]{%

  110.    \vskip\parskip

  111.    \vbox{}% force baselineskip for good positioning by capstart of hyperanchor

  112.    \def\@captype{#1}%

  113.    \capstart

  114. % move back vertically to compensate space inserted by next paragraph

  115.    \vskip-\baselineskip\vskip-\parskip

  116. }%

  117. % use \LTcapwidth (default is 4in) to wrap caption (if line width is bigger)

  118. \newcommand\sphinxcaption[2][\LTcapwidth]{%

  119.    \noindent\hb@xt@\linewidth{\hss

  120.       \vtop{\@tempdima\dimexpr#1\relax

  121. % don't exceed linewidth for the caption width

  122.             \ifdim\@tempdima>\linewidth\hsize\linewidth\else\hsize\@tempdima\fi

  123. % longtable ignores \abovecaptionskip/\belowcaptionskip, so add hooks here

  124. % to uniformize control of caption distance to tables

  125.             \abovecaptionskip\sphinxabovecaptionskip

  126.             \belowcaptionskip\sphinxbelowcaptionskip

  127.             \caption[{#2}]%

  128.                {\strut\ignorespaces#2\ifhmode\unskip\@finalstrut\strutbox\fi}%

  129.            }\hss}%

  130.    \par\prevdepth\dp\strutbox

  131. }%

  132. \def\spx@abovecaptionskip{\abovecaptionskip}

  133. \newcommand*\sphinxabovecaptionskip{\z@skip}

  134. \newcommand*\sphinxbelowcaptionskip{\z@skip}

  135. 

  136. \newcommand\sphinxaftercaption

  137. {% this default definition serves with a caption *above* a table, to make sure

  138.  % its last baseline is \sphinxbelowcaptionspace above table top

  139.  \nobreak

  140.    \vskip\dimexpr\sphinxbelowcaptionspace\relax

  141.    \vskip-\baselineskip\vskip-\parskip

  142. }%

  143. % varwidth is crucial for our handling of general contents in merged cells

  144. \RequirePackage{varwidth}

  145. % but addition of a compatibility patch with hyperref is needed

  146. % (tested with varwidth v 0.92  Mar 2009)

  147. \AtBeginDocument {%

  148.     \let\@@vwid@Hy@raisedlink\Hy@raisedlink

  149.     \long\def\@vwid@Hy@raisedlink#1{\@vwid@wrap{\@@vwid@Hy@raisedlink{#1}}}%

  150.     \edef\@vwid@setup{%

  151.       \let\noexpand\Hy@raisedlink\noexpand\@vwid@Hy@raisedlink % HYPERREF !

  152.       \unexpanded\expandafter{\@vwid@setup}}%

  153. }%

  154. % Homemade package to handle merged cells

  155. \RequirePackage{sphinxmulticell}

  156. \RequirePackage{makeidx}

  157. % For framing code-blocks and warning type notices, and shadowing topics

  158. \RequirePackage{framed}

  159. % The xcolor package draws better fcolorboxes around verbatim code

  160. \IfFileExists{xcolor.sty}{

  161.     \RequirePackage{xcolor}

  162. }{

  163.     \RequirePackage{color}

  164. }

  165. % For highlighted code.

  166. \RequirePackage{fancyvrb}

  167. \define@key{FV}{hllines}{\def\sphinx@verbatim@checkifhl##1{\in@{, ##1,}{#1}}}

  168. % For hyperlinked footnotes in tables; also for gathering footnotes from

  169. % topic and warning blocks. Also to allow code-blocks in footnotes.

  170. \RequirePackage{footnotehyper-sphinx}

  171. % For the H specifier. Do not \restylefloat{figure}, it breaks Sphinx code

  172. % for allowing figures in tables.

  173. \RequirePackage{float}

  174. % For floating figures in the text. Better to load after float.

  175. \RequirePackage{wrapfig}

  176. % Separate paragraphs by space by default.

  177. \RequirePackage{parskip}

  178. % For parsed-literal blocks.

  179. \RequirePackage{alltt}

  180. % Display "real" single quotes in literal blocks.

  181. \RequirePackage{upquote}

  182. % control caption around literal-block

  183. \RequirePackage{capt-of}

  184. \RequirePackage{needspace}

  185. % LaTeX 2018-04-01 and later provides \@removefromreset

  186. \ltx@ifundefined{@removefromreset}

  187.     {\RequirePackage{remreset}}

  188.     {}% avoid warning

  189. % to make pdf with correct encoded bookmarks in Japanese

  190. % this should precede the hyperref package

  191. \ifx\kanjiskip\@undefined

  192. % for non-Japanese: make sure bookmarks are ok also with lualatex

  193.   \PassOptionsToPackage{pdfencoding=unicode}{hyperref}

  194. \else

  195.   \RequirePackage{atbegshi}

  196.   \ifx\ucs\@undefined

  197.     \ifnum 42146=\euc"A4A2

  198.       \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}

  199.     \else

  200.       \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}

  201.     \fi

  202.   \else

  203.     \AtBeginShipoutFirst{\special{pdf:tounicode UTF8-UCS2}}

  204.   \fi

  205. \fi

  206. 

  207. \ifx\@jsc@uplatextrue\@undefined\else

  208.   \PassOptionsToPackage{setpagesize=false}{hyperref}

  209. \fi

  210. 

  211. % These options can be overriden inside  'hyperref' key

  212. % or by later use of \hypersetup.

  213. \PassOptionsToPackage{colorlinks,breaklinks,%

  214.  linkcolor=InnerLinkColor,filecolor=OuterLinkColor,%

  215.  menucolor=OuterLinkColor,urlcolor=OuterLinkColor,%

  216.  citecolor=InnerLinkColor}{hyperref}

  217. 

  218. % stylesheet for highlighting with pygments

  219. \RequirePackage{sphinxhighlight}

  220. % fix baseline increase from Pygments latex formatter in case of error tokens

  221. % and keep \fboxsep's scope local via added braces

  222. \def\PYG@tok@err{%

  223.     \def\PYG@bc##1{{\setlength{\fboxsep}{-\fboxrule}%

  224.                     \fcolorbox[rgb]{1.00,0.00,0.00}{1,1,1}{\strut ##1}}}%

  225. }

  226. \def\PYG@tok@cs{%

  227.     \def\PYG@tc##1{\textcolor[rgb]{0.25,0.50,0.56}{##1}}%

  228.     \def\PYG@bc##1{{\setlength{\fboxsep}{0pt}%

  229.                     \colorbox[rgb]{1.00,0.94,0.94}{\strut ##1}}}%

  230. }%

  231. 

  232. 

  233. %% OPTIONS

  234. %

  235. % Handle options via "kvoptions" (later loaded by hyperref anyhow)

  236. \RequirePackage{kvoptions}

  237. \SetupKeyvalOptions{prefix=spx@opt@} % use \spx@opt@ prefix

  238. 

  239. % Sphinx legacy text layout: 1in margins on all four sides

  240. \ifx\@jsc@uplatextrue\@undefined

  241. \DeclareStringOption[1in]{hmargin}

  242. \DeclareStringOption[1in]{vmargin}

  243. \DeclareStringOption[.5in]{marginpar}

  244. \else

  245. % Japanese standard document classes handle \mag in a special way

  246. \DeclareStringOption[\inv@mag in]{hmargin}

  247. \DeclareStringOption[\inv@mag in]{vmargin}

  248. \DeclareStringOption[.5\dimexpr\inv@mag in\relax]{marginpar}

  249. \fi

  250. 

  251. \DeclareStringOption[0]{maxlistdepth}% \newcommand*\spx@opt@maxlistdepth{0}

  252. \DeclareStringOption[-1]{numfigreset}

  253. \DeclareBoolOption[false]{nonumfigreset}

  254. \DeclareBoolOption[false]{mathnumfig}

  255. % \DeclareBoolOption[false]{usespart}% not used

  256. % dimensions, we declare the \dimen registers here.

  257. \newdimen\sphinxverbatimsep

  258. \newdimen\sphinxverbatimborder

  259. \newdimen\sphinxshadowsep

  260. \newdimen\sphinxshadowsize

  261. \newdimen\sphinxshadowrule

  262. % \DeclareStringOption is not convenient for the handling of these dimensions

  263. % because we want to assign the values to the corresponding registers. Even if

  264. % we added the code to the key handler it would be too late for the initial

  265. % set-up and we would need to do initial assignments explicitely. We end up

  266. % using \define@key directly.

  267. % verbatim

  268. \sphinxverbatimsep=\fboxsep

  269.   \define@key{sphinx}{verbatimsep}{\sphinxverbatimsep\dimexpr #1\relax}

  270. \sphinxverbatimborder=\fboxrule

  271.   \define@key{sphinx}{verbatimborder}{\sphinxverbatimborder\dimexpr #1\relax}

  272. % topic boxes

  273. \sphinxshadowsep =5pt

  274.   \define@key{sphinx}{shadowsep}{\sphinxshadowsep\dimexpr #1\relax}

  275. \sphinxshadowsize=4pt

  276.   \define@key{sphinx}{shadowsize}{\sphinxshadowsize\dimexpr #1\relax}

  277. \sphinxshadowrule=\fboxrule

  278.   \define@key{sphinx}{shadowrule}{\sphinxshadowrule\dimexpr #1\relax}

  279. % verbatim

  280. \DeclareBoolOption[true]{verbatimwithframe}

  281. \DeclareBoolOption[true]{verbatimwrapslines}

  282. \DeclareBoolOption[true]{verbatimhintsturnover}

  283. \DeclareBoolOption[true]{inlineliteralwraps}

  284. \DeclareStringOption[t]{literalblockcappos}

  285. \DeclareStringOption[r]{verbatimcontinuedalign}

  286. \DeclareStringOption[r]{verbatimcontinuesalign}

  287. % parsed literal

  288. \DeclareBoolOption[true]{parsedliteralwraps}

  289. % \textvisiblespace for compatibility with fontspec+XeTeX/LuaTeX

  290. \DeclareStringOption[\textcolor{red}{\textvisiblespace}]{verbatimvisiblespace}

  291. \DeclareStringOption % must use braces to hide the brackets

  292.   [{\makebox[2\fontcharwd\font`\x][r]{\textcolor{red}{\tiny$\m@th\hookrightarrow$}}}]%

  293.   {verbatimcontinued}

  294. % notices/admonitions

  295. % the dimensions for notices/admonitions are kept as macros and assigned to

  296. % \spx@notice@border at time of use, hence \DeclareStringOption is ok for this

  297. \newdimen\spx@notice@border

  298. \DeclareStringOption[0.5pt]{noteborder}

  299. \DeclareStringOption[0.5pt]{hintborder}

  300. \DeclareStringOption[0.5pt]{importantborder}

  301. \DeclareStringOption[0.5pt]{tipborder}

  302. \DeclareStringOption[1pt]{warningborder}

  303. \DeclareStringOption[1pt]{cautionborder}

  304. \DeclareStringOption[1pt]{attentionborder}

  305. \DeclareStringOption[1pt]{dangerborder}

  306. \DeclareStringOption[1pt]{errorborder}

  307. % footnotes

  308. \DeclareStringOption[\mbox{ }]{AtStartFootnote}

  309. % we need a public macro name for direct use in latex file

  310. \newcommand*{\sphinxAtStartFootnote}{\spx@opt@AtStartFootnote}

  311. % no such need for this one, as it is used inside other macros

  312. \DeclareStringOption[\leavevmode\unskip]{BeforeFootnote}

  313. % some font styling.

  314. \DeclareStringOption[\sffamily\bfseries]{HeaderFamily}

  315. % colours

  316. % same problems as for dimensions: we want the key handler to use \definecolor.

  317. % first, some colours with no prefix, for backwards compatibility

  318. \newcommand*{\sphinxDeclareColorOption}[2]{%

  319.    \definecolor{#1}#2%

  320.    \define@key{sphinx}{#1}{\definecolor{#1}##1}%

  321. }%

  322. \sphinxDeclareColorOption{TitleColor}{{rgb}{0.126,0.263,0.361}}

  323. \sphinxDeclareColorOption{InnerLinkColor}{{rgb}{0.208,0.374,0.486}}

  324. \sphinxDeclareColorOption{OuterLinkColor}{{rgb}{0.216,0.439,0.388}}

  325. \sphinxDeclareColorOption{VerbatimColor}{{rgb}{1,1,1}}

  326. \sphinxDeclareColorOption{VerbatimBorderColor}{{rgb}{0,0,0}}

  327. % now the colours defined with "sphinx" prefix in their names

  328. \newcommand*{\sphinxDeclareSphinxColorOption}[2]{%

  329.    % set the initial default

  330.    \definecolor{sphinx#1}#2%

  331.    % set the key handler. The "value" ##1 must be acceptable by \definecolor.

  332.    \define@key{sphinx}{#1}{\definecolor{sphinx#1}##1}%

  333. }%

  334. % Default color chosen to be as in minted.sty LaTeX package!

  335. \sphinxDeclareSphinxColorOption{VerbatimHighlightColor}{{rgb}{0.878,1,1}}

  336. % admonition boxes, "light" style

  337. \sphinxDeclareSphinxColorOption{noteBorderColor}{{rgb}{0,0,0}}

  338. \sphinxDeclareSphinxColorOption{hintBorderColor}{{rgb}{0,0,0}}

  339. \sphinxDeclareSphinxColorOption{importantBorderColor}{{rgb}{0,0,0}}

  340. \sphinxDeclareSphinxColorOption{tipBorderColor}{{rgb}{0,0,0}}

  341. % admonition boxes, "heavy" style

  342. \sphinxDeclareSphinxColorOption{warningBorderColor}{{rgb}{0,0,0}}

  343. \sphinxDeclareSphinxColorOption{cautionBorderColor}{{rgb}{0,0,0}}

  344. \sphinxDeclareSphinxColorOption{attentionBorderColor}{{rgb}{0,0,0}}

  345. \sphinxDeclareSphinxColorOption{dangerBorderColor}{{rgb}{0,0,0}}

  346. \sphinxDeclareSphinxColorOption{errorBorderColor}{{rgb}{0,0,0}}

  347. \sphinxDeclareSphinxColorOption{warningBgColor}{{rgb}{1,1,1}}

  348. \sphinxDeclareSphinxColorOption{cautionBgColor}{{rgb}{1,1,1}}

  349. \sphinxDeclareSphinxColorOption{attentionBgColor}{{rgb}{1,1,1}}

  350. \sphinxDeclareSphinxColorOption{dangerBgColor}{{rgb}{1,1,1}}

  351. \sphinxDeclareSphinxColorOption{errorBgColor}{{rgb}{1,1,1}}

  352. 

  353. \DeclareDefaultOption{\@unknownoptionerror}

  354. \ProcessKeyvalOptions*

  355. % don't allow use of maxlistdepth via \sphinxsetup.

  356. \DisableKeyvalOption{sphinx}{maxlistdepth}

  357. \DisableKeyvalOption{sphinx}{numfigreset}

  358. \DisableKeyvalOption{sphinx}{nonumfigreset}

  359. \DisableKeyvalOption{sphinx}{mathnumfig}

  360. % user interface: options can be changed midway in a document!

  361. \newcommand\sphinxsetup[1]{\setkeys{sphinx}{#1}}

  362. 

  363. 

  364. %% MAXLISTDEPTH

  365. %

  366. % remove LaTeX's cap on nesting depth if 'maxlistdepth' key used.

  367. % This is a hack, which works with the standard classes: it assumes \@toodeep

  368. % is always used in "true" branches: "\if ... \@toodeep \else .. \fi."

  369. 

  370. % will force use the "false" branch (if there is one)

  371. \def\spx@toodeep@hack{\fi\iffalse}

  372. 

  373. % do nothing if 'maxlistdepth' key not used or if package enumitem loaded.

  374. \ifnum\spx@opt@maxlistdepth=\z@\expandafter\@gobbletwo\fi

  375. \AtBeginDocument{%

  376. \@ifpackageloaded{enumitem}{\remove@to@nnil}{}%

  377.   \let\spx@toodeepORI\@toodeep

  378.   \def\@toodeep{%

  379.     \ifnum\@listdepth<\spx@opt@maxlistdepth\relax

  380.       \expandafter\spx@toodeep@hack

  381.     \else

  382.       \expandafter\spx@toodeepORI

  383.     \fi}%

  384. % define all missing \@list... macros

  385.   \count@\@ne

  386.   \loop

  387.      \ltx@ifundefined{@list\romannumeral\the\count@}

  388.        {\iffalse}{\iftrue\advance\count@\@ne}%

  389.   \repeat

  390.   \loop

  391.      \ifnum\count@>\spx@opt@maxlistdepth\relax\else

  392.        \expandafter\let

  393.          \csname @list\romannumeral\the\count@\expandafter\endcsname

  394.          \csname @list\romannumeral\the\numexpr\count@-\@ne\endcsname

  395.        % workaround 2.6--3.2d babel-french issue (fixed in 3.2e; no change needed)

  396.        \ltx@ifundefined{leftmargin\romannumeral\the\count@}

  397.        {\expandafter\let

  398.          \csname leftmargin\romannumeral\the\count@\expandafter\endcsname

  399.          \csname leftmargin\romannumeral\the\numexpr\count@-\@ne\endcsname}{}%

  400.      \advance\count@\@ne

  401.   \repeat

  402. % define all missing enum... counters and \labelenum... macros and \p@enum..

  403.   \count@\@ne

  404.   \loop

  405.      \ltx@ifundefined{c@enum\romannumeral\the\count@}

  406.        {\iffalse}{\iftrue\advance\count@\@ne}%

  407.   \repeat

  408.   \loop

  409.      \ifnum\count@>\spx@opt@maxlistdepth\relax\else

  410.        \newcounter{enum\romannumeral\the\count@}%

  411.        \expandafter\def

  412.          \csname labelenum\romannumeral\the\count@\expandafter\endcsname

  413.          \expandafter

  414.          {\csname theenum\romannumeral\the\numexpr\count@\endcsname.}%

  415.        \expandafter\def

  416.          \csname p@enum\romannumeral\the\count@\expandafter\endcsname

  417.          \expandafter

  418.          {\csname p@enum\romannumeral\the\numexpr\count@-\@ne\expandafter

  419.           \endcsname\csname theenum\romannumeral\the\numexpr\count@-\@ne\endcsname.}%

  420.      \advance\count@\@ne

  421.   \repeat

  422. % define all missing labelitem... macros

  423.   \count@\@ne

  424.   \loop

  425.      \ltx@ifundefined{labelitem\romannumeral\the\count@}

  426.      {\iffalse}{\iftrue\advance\count@\@ne}%

  427.   \repeat

  428.   \loop

  429.      \ifnum\count@>\spx@opt@maxlistdepth\relax\else

  430.        \expandafter\let

  431.          \csname labelitem\romannumeral\the\count@\expandafter\endcsname

  432.          \csname labelitem\romannumeral\the\numexpr\count@-\@ne\endcsname

  433.      \advance\count@\@ne

  434.   \repeat

  435.   \PackageInfo{sphinx}{maximal list depth extended to \spx@opt@maxlistdepth}%

  436. \@gobble\@nnil

  437. }

  438. 

  439. 

  440. %% INDEX, BIBLIOGRAPHY, APPENDIX, TABLE OF CONTENTS

  441. %

  442. % fix the double index and bibliography on the table of contents

  443. % in jsclasses (Japanese standard document classes)

  444. \ifx\@jsc@uplatextrue\@undefined\else

  445.   \renewenvironment{sphinxtheindex}

  446.     {\cleardoublepage\phantomsection

  447.      \begin{theindex}}

  448.     {\end{theindex}}

  449. 

  450.   \renewenvironment{sphinxthebibliography}[1]

  451.     {\cleardoublepage% \phantomsection % not needed here since TeXLive 2010's hyperref

  452.      \begin{thebibliography}{#1}}

  453.     {\end{thebibliography}}

  454. \fi

  455. 

  456. % disable \@chappos in Appendix in pTeX

  457. \ifx\kanjiskip\@undefined\else

  458.   \let\py@OldAppendix=\appendix

  459.   \renewcommand{\appendix}{

  460.     \py@OldAppendix

  461.     \gdef\@chappos{}

  462.   }

  463. \fi

  464. 

  465. % make commands known to non-Sphinx document classes

  466. \providecommand*{\sphinxtableofcontents}{\tableofcontents}

  467. \ltx@ifundefined{sphinxthebibliography}

  468.  {\newenvironment

  469.   {sphinxthebibliography}{\begin{thebibliography}}{\end{thebibliography}}%

  470.  }

  471.  {}% else clause of \ltx@ifundefined

  472. \ltx@ifundefined{sphinxtheindex}

  473.  {\newenvironment{sphinxtheindex}{\begin{theindex}}{\end{theindex}}}%

  474.  {}% else clause of \ltx@ifundefined

  475. 

  476. % for usage with xindy: this string gets internationalized in preamble

  477. \newcommand*{\sphinxnonalphabeticalgroupname}{}

  478. % redefined in preamble, headings for makeindex produced index

  479. \newcommand*{\sphinxsymbolsname}{}

  480. \newcommand*{\sphinxnumbersname}{}

  481. 

  482. %% COLOR (general)

  483. %

  484. % FIXME: \normalcolor should probably be used in place of \py@NormalColor

  485. % elsewhere, and \py@NormalColor should never be defined. \normalcolor

  486. % switches to the colour from last \color call in preamble.

  487. \def\py@NormalColor{\color{black}}

  488. % FIXME: it is probably better to use \color{TitleColor}, as TitleColor

  489. % can be customized from 'sphinxsetup', and drop usage of \py@TitleColor

  490. \def\py@TitleColor{\color{TitleColor}}

  491. % FIXME: this line should be dropped, as "9" is default anyhow.

  492. \ifdefined\pdfcompresslevel\pdfcompresslevel = 9 \fi

  493. 

  494. 

  495. %% PAGE STYLING

  496. %

  497. % Style parameters and macros used by most documents here

  498. \raggedbottom

  499. \sloppy

  500. \hbadness = 5000                % don't print trivial gripes

  501. 

  502. \pagestyle{empty}               % start this way

  503. 

  504. % Redefine the 'normal' header/footer style when using "fancyhdr" package:

  505. % Note: this presupposes "twoside". If "oneside" class option, there will be warnings.

  506. \ltx@ifundefined{fancyhf}{}{

  507.   % Use \pagestyle{normal} as the primary pagestyle for text.

  508.   \fancypagestyle{normal}{

  509.     \fancyhf{}

  510. % (for \py@HeaderFamily cf "TITLES")

  511.     \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}

  512.     \fancyfoot[LO]{{\py@HeaderFamily\nouppercase{\rightmark}}}

  513.     \fancyfoot[RE]{{\py@HeaderFamily\nouppercase{\leftmark}}}

  514.     \fancyhead[LE,RO]{{\py@HeaderFamily \@title\sphinxheadercomma\py@release}}

  515.     \renewcommand{\headrulewidth}{0.4pt}

  516.     \renewcommand{\footrulewidth}{0.4pt}

  517.     % define chaptermark with \@chappos when \@chappos is available for Japanese

  518.     \ltx@ifundefined{@chappos}{}

  519.       {\def\chaptermark##1{\markboth{\@chapapp\space\thechapter\space\@chappos\space ##1}{}}}

  520.   }

  521.   % Update the plain style so we get the page number & footer line,

  522.   % but not a chapter or section title.  This is to keep the first

  523.   % page of a chapter and the blank page between chapters `clean.'

  524.   \fancypagestyle{plain}{

  525.     \fancyhf{}

  526.     \fancyfoot[LE,RO]{{\py@HeaderFamily\thepage}}

  527.     \renewcommand{\headrulewidth}{0pt}

  528.     \renewcommand{\footrulewidth}{0.4pt}

  529.   }

  530. }

  531. 

  532. % geometry

  533. \ifx\kanjiskip\@undefined

  534.   \PassOptionsToPackage{%

  535.      hmargin={\unexpanded{\spx@opt@hmargin}},%

  536.      vmargin={\unexpanded{\spx@opt@vmargin}},%

  537.      marginpar=\unexpanded{\spx@opt@marginpar}}

  538.   {geometry}

  539. \else

  540.  % set text width for Japanese documents to be integer multiple of 1zw

  541.  % and text height to be integer multiple of \baselineskip

  542.  % the execution is delayed to \sphinxsetup then geometry.sty

  543.  \normalsize\normalfont

  544.  \newcommand*\sphinxtextwidthja[1]{%

  545.     \if@twocolumn\tw@\fi

  546.     \dimexpr

  547.        \numexpr\dimexpr\paperwidth-\tw@\dimexpr#1\relax\relax/

  548.                \dimexpr\if@twocolumn\tw@\else\@ne\fi zw\relax

  549.     zw\relax}%

  550.  \newcommand*\sphinxmarginparwidthja[1]{%

  551.     \dimexpr\numexpr\dimexpr#1\relax/\dimexpr1zw\relax zw\relax}%

  552.  \newcommand*\sphinxtextlinesja[1]{%

  553.     \numexpr\@ne+\dimexpr\paperheight-\topskip-\tw@\dimexpr#1\relax\relax/

  554.                  \baselineskip\relax}%

  555.  \ifx\@jsc@uplatextrue\@undefined\else

  556.  % the way we found in order for the papersize special written by

  557.  % geometry in the dvi file to be correct in case of jsbook class

  558.    \ifnum\mag=\@m\else % do nothing special if nomag class option or 10pt

  559.      \PassOptionsToPackage{truedimen}{geometry}%

  560.    \fi

  561.  \fi

  562.  \PassOptionsToPackage{%

  563.     hmarginratio={1:1},%

  564.     textwidth=\unexpanded{\sphinxtextwidthja{\spx@opt@hmargin}},%

  565.     vmarginratio={1:1},%

  566.     lines=\unexpanded{\sphinxtextlinesja{\spx@opt@vmargin}},%

  567.     marginpar=\unexpanded{\sphinxmarginparwidthja{\spx@opt@marginpar}},%

  568.     footskip=2\baselineskip,%

  569.   }{geometry}%

  570.  \AtBeginDocument

  571.  {% update a dimension used by the jsclasses

  572.   \ifx\@jsc@uplatextrue\@undefined\else\fullwidth\textwidth\fi

  573.   % for some reason, jreport normalizes all dimensions with \@settopoint

  574.   \@ifclassloaded{jreport}

  575.     {\@settopoint\textwidth\@settopoint\textheight\@settopoint\marginparwidth}

  576.     {}% <-- "false" clause of \@ifclassloaded

  577.   }%

  578. \fi

  579. 

  580. % fix fncychap's bug which uses prematurely the \textwidth value

  581. \@ifpackagewith{fncychap}{Bjornstrup}

  582.  {\AtBeginDocument{\mylen\textwidth\advance\mylen-2\myhi}}%

  583.  {}% <-- "false" clause of \@ifpackagewith

  584. 

  585. 

  586. %% TITLES

  587. %

  588. % Since Sphinx 1.5, users should use HeaderFamily key to 'sphinxsetup' rather

  589. % than defining their own \py@HeaderFamily command (which is still possible).

  590. % Memo: \py@HeaderFamily is also used by \maketitle as defined in

  591. % sphinxmanual.cls/sphinxhowto.cls

  592. \newcommand{\py@HeaderFamily}{\spx@opt@HeaderFamily}

  593. 

  594. % This sets up the fancy chapter headings that make the documents look

  595. % at least a little better than the usual LaTeX output.

  596. \@ifpackagewith{fncychap}{Bjarne}{

  597.   \ChNameVar {\raggedleft\normalsize \py@HeaderFamily}

  598.   \ChNumVar  {\raggedleft\Large      \py@HeaderFamily}

  599.   \ChTitleVar{\raggedleft\Large      \py@HeaderFamily}

  600.   % This creates (numbered) chapter heads without the leading \vspace*{}:

  601.   \def\@makechapterhead#1{%

  602.     {\parindent \z@ \raggedright \normalfont

  603.       \ifnum \c@secnumdepth >\m@ne

  604.         \if@mainmatter

  605.           \DOCH

  606.         \fi

  607.       \fi

  608.       \interlinepenalty\@M

  609.       \if@mainmatter

  610.         \DOTI{#1}%

  611.       \else%

  612.         \DOTIS{#1}%

  613.       \fi

  614.     }}

  615. }{}% <-- "false" clause of \@ifpackagewith

  616. 

  617. % Augment the sectioning commands used to get our own font family in place,

  618. % and reset some internal data items (\titleformat from titlesec package)

  619. \titleformat{\section}{\Large\py@HeaderFamily}%

  620.             {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor}

  621. \titleformat{\subsection}{\large\py@HeaderFamily}%

  622.             {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}

  623. \titleformat{\subsubsection}{\py@HeaderFamily}%

  624.             {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor}

  625. % By default paragraphs (and subsubsections) will not be numbered because

  626. % sphinxmanual.cls and sphinxhowto.cls set secnumdepth to 2

  627. \titleformat{\paragraph}{\py@HeaderFamily}%

  628.             {\py@TitleColor\theparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}

  629. \titleformat{\subparagraph}{\py@HeaderFamily}%

  630.             {\py@TitleColor\thesubparagraph}{0.5em}{\py@TitleColor}{\py@NormalColor}

  631. 

  632. 

  633. %% GRAPHICS

  634. %

  635. % \sphinxincludegraphics defined to resize images larger than the line width,

  636. % except if height or width option present.

  637. %

  638. % If scale is present, rescale before fitting to line width. (since 1.5)

  639. \newbox\spx@image@box

  640. \newcommand*{\sphinxincludegraphics}[2][]{%

  641.   \in@{height}{#1}\ifin@\else\in@{width}{#1}\fi

  642.   \ifin@ % height or width present

  643.     \includegraphics[#1]{#2}%

  644.   \else % no height nor width (but #1 may be "scale=...")

  645.     \setbox\spx@image@box\hbox{\includegraphics[#1,draft]{#2}}%

  646.     \ifdim \wd\spx@image@box>\linewidth

  647.       \setbox\spx@image@box\box\voidb@x % clear memory

  648.       \includegraphics[#1,width=\linewidth]{#2}%

  649.     \else

  650.       \includegraphics[#1]{#2}%

  651.     \fi

  652.   \fi

  653. }

  654. 

  655. 

  656. %% FIGURE IN TABLE

  657. %

  658. \newenvironment{sphinxfigure-in-table}[1][\linewidth]{%

  659.   \def\@captype{figure}%

  660.   \sphinxsetvskipsforfigintablecaption

  661.   \begin{minipage}{#1}%

  662. }{\end{minipage}}

  663. % store original \caption macro for use with figures in longtable and tabulary

  664. \AtBeginDocument{\let\spx@originalcaption\caption}

  665. \newcommand*\sphinxfigcaption

  666.   {\ifx\equation$%$% this is trick to identify tabulary first pass

  667.        \firstchoice@false\else\firstchoice@true\fi

  668.    \spx@originalcaption }

  669. \newcommand*\sphinxsetvskipsforfigintablecaption

  670.   {\abovecaptionskip\smallskipamount

  671.    \belowcaptionskip\smallskipamount}

  672. 

  673. 

  674. %% CITATIONS

  675. %

  676. \protected\def\sphinxcite{\cite}

  677. 

  678. %% FOOTNOTES

  679. %

  680. % Support large numbered footnotes in minipage

  681. % But now obsolete due to systematic use of \savenotes/\spewnotes

  682. % when minipages are in use in the various macro definitions next.

  683. \def\thempfootnote{\arabic{mpfootnote}}

  684. 

  685. 

  686. %% NUMBERING OF FIGURES, TABLES, AND LITERAL BLOCKS

  687. \ltx@ifundefined{c@chapter}

  688.    {\newcounter{literalblock}}%

  689.    {\newcounter{literalblock}[chapter]%

  690.     \def\theliteralblock{\ifnum\c@chapter>\z@\arabic{chapter}.\fi

  691.                          \arabic{literalblock}}%

  692.     }%

  693. \ifspx@opt@nonumfigreset

  694.     \ltx@ifundefined{c@chapter}{}{%

  695.       \@removefromreset{figure}{chapter}%

  696.       \@removefromreset{table}{chapter}%

  697.       \@removefromreset{literalblock}{chapter}%

  698.       \ifspx@opt@mathnumfig

  699.         \@removefromreset{equation}{chapter}%

  700.       \fi

  701.     }%

  702.     \def\thefigure{\arabic{figure}}%

  703.     \def\thetable {\arabic{table}}%

  704.     \def\theliteralblock{\arabic{literalblock}}%

  705.     \ifspx@opt@mathnumfig

  706.       \def\theequation{\arabic{equation}}%

  707.     \fi

  708. \else

  709. \let\spx@preAthefigure\@empty

  710. \let\spx@preBthefigure\@empty

  711. % \ifspx@opt@usespart  % <-- LaTeX writer could pass such a 'usespart' boolean

  712. %                      %     as sphinx.sty package option

  713. % If document uses \part, (triggered in Sphinx by latex_toplevel_sectioning)

  714. % LaTeX core per default does not reset chapter or section

  715. % counters at each part.

  716. % But if we modify this, we need to redefine \thechapter, \thesection to

  717. % include the part number and this will cause problems in table of contents

  718. % because of too wide numbering. Simplest is to do nothing.

  719. % \fi

  720. \ifnum\spx@opt@numfigreset>0

  721.     \ltx@ifundefined{c@chapter}

  722.       {}

  723.       {\g@addto@macro\spx@preAthefigure{\ifnum\c@chapter>\z@\arabic{chapter}.}%

  724.        \g@addto@macro\spx@preBthefigure{\fi}}%

  725. \fi

  726. \ifnum\spx@opt@numfigreset>1

  727.     \@addtoreset{figure}{section}%

  728.     \@addtoreset{table}{section}%

  729.     \@addtoreset{literalblock}{section}%

  730.     \ifspx@opt@mathnumfig

  731.       \@addtoreset{equation}{section}%

  732.     \fi

  733.     \g@addto@macro\spx@preAthefigure{\ifnum\c@section>\z@\arabic{section}.}%

  734.     \g@addto@macro\spx@preBthefigure{\fi}%

  735. \fi

  736. \ifnum\spx@opt@numfigreset>2

  737.     \@addtoreset{figure}{subsection}%

  738.     \@addtoreset{table}{subsection}%

  739.     \@addtoreset{literalblock}{subsection}%

  740.     \ifspx@opt@mathnumfig

  741.       \@addtoreset{equation}{subsection}%

  742.     \fi

  743.     \g@addto@macro\spx@preAthefigure{\ifnum\c@subsection>\z@\arabic{subsection}.}%

  744.     \g@addto@macro\spx@preBthefigure{\fi}%

  745. \fi

  746. \ifnum\spx@opt@numfigreset>3

  747.     \@addtoreset{figure}{subsubsection}%

  748.     \@addtoreset{table}{subsubsection}%

  749.     \@addtoreset{literalblock}{subsubsection}%

  750.     \ifspx@opt@mathnumfig

  751.       \@addtoreset{equation}{subsubsection}%

  752.     \fi

  753.     \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubsection>\z@\arabic{subsubsection}.}%

  754.     \g@addto@macro\spx@preBthefigure{\fi}%

  755. \fi

  756. \ifnum\spx@opt@numfigreset>4

  757.     \@addtoreset{figure}{paragraph}%

  758.     \@addtoreset{table}{paragraph}%

  759.     \@addtoreset{literalblock}{paragraph}%

  760.     \ifspx@opt@mathnumfig

  761.       \@addtoreset{equation}{paragraph}%

  762.     \fi

  763.     \g@addto@macro\spx@preAthefigure{\ifnum\c@subparagraph>\z@\arabic{subparagraph}.}%

  764.     \g@addto@macro\spx@preBthefigure{\fi}%

  765. \fi

  766. \ifnum\spx@opt@numfigreset>5

  767.     \@addtoreset{figure}{subparagraph}%

  768.     \@addtoreset{table}{subparagraph}%

  769.     \@addtoreset{literalblock}{subparagraph}%

  770.     \ifspx@opt@mathnumfig

  771.       \@addtoreset{equation}{subparagraph}%

  772.     \fi

  773.     \g@addto@macro\spx@preAthefigure{\ifnum\c@subsubparagraph>\z@\arabic{subsubparagraph}.}%

  774.     \g@addto@macro\spx@preBthefigure{\fi}%

  775. \fi

  776. \expandafter\g@addto@macro

  777. \expandafter\spx@preAthefigure\expandafter{\spx@preBthefigure}%

  778. \let\thefigure\spx@preAthefigure

  779. \let\thetable\spx@preAthefigure

  780. \let\theliteralblock\spx@preAthefigure

  781. \g@addto@macro\thefigure{\arabic{figure}}%

  782. \g@addto@macro\thetable{\arabic{table}}%

  783. \g@addto@macro\theliteralblock{\arabic{literalblock}}%

  784.   \ifspx@opt@mathnumfig

  785.     \let\theequation\spx@preAthefigure

  786.     \g@addto@macro\theequation{\arabic{equation}}%

  787.   \fi

  788. \fi

  789. 

  790. 

  791. %% LITERAL BLOCKS

  792. %

  793. % Based on use of "fancyvrb.sty"'s Verbatim.

  794. % - with framing allowing page breaks ("framed.sty")

  795. % - with breaking of long lines (exploits Pygments mark-up),

  796. % - with possibly of a top caption, non-separable by pagebreak.

  797. % - and usable inside tables or footnotes ("footnotehyper-sphinx").

  798. 

  799. % For extensions which use \OriginalVerbatim and compatibility with Sphinx <

  800. % 1.5, we define and use these when (unmodified) Verbatim will be needed. But

  801. % Sphinx >= 1.5 does not modify the \Verbatim macro anymore.

  802. \let\OriginalVerbatim   \Verbatim

  803. \let\endOriginalVerbatim\endVerbatim

  804. 

  805. % for captions of literal blocks

  806. % at start of caption title

  807. \newcommand*{\fnum@literalblock}{\literalblockname\nobreakspace\theliteralblock}

  808. % this will be overwritten in document preamble by Babel translation

  809. \newcommand*{\literalblockname}{Listing }

  810. % file extension needed for \caption's good functioning, the file is created

  811. % only if a \listof{literalblock}{foo} command is encountered, which is

  812. % analogous to \listoffigures, but for the code listings (foo = chosen title.)

  813. \newcommand*{\ext@literalblock}{lol}

  814. 

  815. \newif\ifspx@inframed % flag set if we are already in a framed environment

  816. % if forced use of minipage encapsulation is needed (e.g. table cells)

  817. \newif\ifsphinxverbatimwithminipage   \sphinxverbatimwithminipagefalse

  818. 

  819. % Framing macro for use with framed.sty's \FrameCommand

  820. %  - it obeys current indentation,

  821. %  - frame is \fboxsep separated from the contents,

  822. %  - the contents use the full available text width,

  823. %  - #1 = color of frame, #2 = color of background,

  824. %  - #3 = above frame, #4 = below frame, #5 = within frame,

  825. %  - #3 and #4 must be already typeset boxes; they must issue \normalcolor

  826. %    or similar, else, they are under scope of color #1

  827. \long\def\spx@fcolorbox #1#2#3#4#5{%

  828.   \hskip\@totalleftmargin

  829.   \hskip-\fboxsep\hskip-\fboxrule

  830.   % use of \color@b@x here is compatible with both xcolor.sty and color.sty

  831.   \color@b@x {\color{#1}\spx@CustomFBox{#3}{#4}}{\color{#2}}{#5}%

  832.   \hskip-\fboxsep\hskip-\fboxrule

  833.   \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth

  834. }%

  835. % #1 = for material above frame, such as a caption or a "continued" hint

  836. % #2 = for material below frame, such as a caption or "continues on next page"

  837. % #3 = actual contents, which will be typeset with a background color

  838. \long\def\spx@CustomFBox#1#2#3{%

  839.   \begingroup

  840.   \setbox\@tempboxa\hbox{{#3}}% inner braces to avoid color leaks

  841.   \vbox{#1% above frame

  842.             % draw frame border _latest_ to avoid pdf viewer issue

  843.             \kern\fboxrule

  844.             \hbox{\kern\fboxrule

  845.                   \copy\@tempboxa

  846.                   \kern-\wd\@tempboxa\kern-\fboxrule

  847.                   \vrule\@width\fboxrule

  848.                   \kern\wd\@tempboxa

  849.                   \vrule\@width\fboxrule}%

  850.             \kern-\dimexpr\ht\@tempboxa+\dp\@tempboxa+\fboxrule\relax

  851.             \hrule\@height\fboxrule

  852.             \kern\dimexpr\ht\@tempboxa+\dp\@tempboxa\relax

  853.             \hrule\@height\fboxrule

  854.         #2% below frame

  855.        }%

  856.   \endgroup

  857. }%

  858. \def\spx@fcolorbox@put@c#1{% hide width from framed.sty measuring

  859.     \moveright\dimexpr\fboxrule+.5\wd\@tempboxa\hb@xt@\z@{\hss#1\hss}%

  860. }%

  861. \def\spx@fcolorbox@put@r#1{% right align with contents, width hidden

  862.     \moveright\dimexpr\fboxrule+\wd\@tempboxa-\fboxsep\hb@xt@\z@{\hss#1}%

  863. }%

  864. \def\spx@fcolorbox@put@l#1{% left align with contents, width hidden

  865.     \moveright\dimexpr\fboxrule+\fboxsep\hb@xt@\z@{#1\hss}%

  866. }%

  867. %

  868. \def\sphinxVerbatim@Continued

  869.    {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuedalign\endcsname

  870.     {\normalcolor\sphinxstylecodecontinued\literalblockcontinuedname}}%

  871. \def\sphinxVerbatim@Continues

  872.    {\csname spx@fcolorbox@put@\spx@opt@verbatimcontinuesalign\endcsname

  873.     {\normalcolor\sphinxstylecodecontinues\literalblockcontinuesname}}%

  874. \def\sphinxVerbatim@Title

  875.    {\spx@fcolorbox@put@c{\unhcopy\sphinxVerbatim@TitleBox}}%

  876. \let\sphinxVerbatim@Before\@empty

  877. \let\sphinxVerbatim@After\@empty

  878. % Defaults are redefined in document preamble according to language

  879. \newcommand*\literalblockcontinuedname{continued from previous page}%

  880. \newcommand*\literalblockcontinuesname{continues on next page}%

  881. %

  882. \def\spx@verbatimfcolorbox{\spx@fcolorbox{VerbatimBorderColor}{VerbatimColor}}%

  883. \def\sphinxVerbatim@FrameCommand

  884.    {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@After}%

  885. \def\sphinxVerbatim@FirstFrameCommand

  886.    {\spx@verbatimfcolorbox\sphinxVerbatim@Before\sphinxVerbatim@Continues}%

  887. \def\sphinxVerbatim@MidFrameCommand

  888.    {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@Continues}%

  889. \def\sphinxVerbatim@LastFrameCommand

  890.    {\spx@verbatimfcolorbox\sphinxVerbatim@Continued\sphinxVerbatim@After}%

  891. 

  892. % For linebreaks inside Verbatim environment from package fancyvrb.

  893. \newbox\sphinxcontinuationbox

  894. \newbox\sphinxvisiblespacebox

  895. \newcommand*\sphinxafterbreak {\copy\sphinxcontinuationbox}

  896. 

  897. % Take advantage of the already applied Pygments mark-up to insert

  898. % potential linebreaks for TeX processing.

  899. %        {, <, #, %, $, ' and ": go to next line.

  900. %        _, }, ^, &, >, - and ~: stay at end of broken line.

  901. % Use of \textquotesingle for straight quote.

  902. % FIXME: convert this to package options ?

  903. \newcommand*\sphinxbreaksbeforelist {%

  904.     \do\PYGZob\{\do\PYGZlt\<\do\PYGZsh\#\do\PYGZpc\%% {, <, #, %,

  905.     \do\PYGZdl\$\do\PYGZdq\"% $, "

  906.     \def\PYGZsq

  907.      {\discretionary{}{\sphinxafterbreak\textquotesingle}{\textquotesingle}}% '

  908. }

  909. \newcommand*\sphinxbreaksafterlist {%

  910.     \do\PYGZus\_\do\PYGZcb\}\do\PYGZca\^\do\PYGZam\&% _, }, ^, &,

  911.     \do\PYGZgt\>\do\PYGZhy\-\do\PYGZti\~% >, -, ~

  912. }

  913. \newcommand*\sphinxbreaksatspecials {%

  914.   \def\do##1##2%

  915.      {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%

  916.   \sphinxbreaksbeforelist

  917.   \def\do##1##2%

  918.      {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%

  919.   \sphinxbreaksafterlist

  920. }

  921. 

  922. \def\sphinx@verbatim@nolig@list {\do \`}%

  923. % Some characters . , ; ? ! / are not pygmentized.

  924. % This macro makes them "active" and they will insert potential linebreaks.

  925. % Not compatible with math mode (cf \sphinxunactivateextras).

  926. \newcommand*\sphinxbreaksbeforeactivelist {}% none

  927. \newcommand*\sphinxbreaksafteractivelist  {\do\.\do\,\do\;\do\?\do\!\do\/}

  928. \newcommand*\sphinxbreaksviaactive {%

  929.    \def\do##1{\lccode`\~`##1%

  930.     \lowercase{\def~}{\discretionary{}{\sphinxafterbreak\char`##1}{\char`##1}}%

  931.     \catcode`##1\active}%

  932.    \sphinxbreaksbeforeactivelist

  933.    \def\do##1{\lccode`\~`##1%

  934.     \lowercase{\def~}{\discretionary{\char`##1}{\sphinxafterbreak}{\char`##1}}%

  935.     \catcode`##1\active}%

  936.    \sphinxbreaksafteractivelist

  937.    \lccode`\~`\~

  938. }

  939. 

  940. % If the linebreak is at a space, the latter will be displayed as visible

  941. % space at end of first line, and a continuation symbol starts next line.

  942. \def\spx@verbatim@space {%

  943.      \nobreak\hskip\z@skip

  944.      \discretionary{\copy\sphinxvisiblespacebox}{\sphinxafterbreak}

  945.                    {\kern\fontdimen2\font}%

  946. }%

  947. 

  948. % if the available space on page is less than \literalblockneedspace, insert pagebreak

  949. \newcommand{\sphinxliteralblockneedspace}{5\baselineskip}

  950. \newcommand{\sphinxliteralblockwithoutcaptionneedspace}{1.5\baselineskip}

  951. % The title (caption) is specified from outside as macro \sphinxVerbatimTitle.

  952. % \sphinxVerbatimTitle is reset to empty after each use of Verbatim.

  953. \newcommand*\sphinxVerbatimTitle {}

  954. % This box to typeset the caption before framed.sty multiple passes for framing.

  955. \newbox\sphinxVerbatim@TitleBox

  956. % This is a workaround to a "feature" of French lists, when literal block

  957. % follows immediately; usable generally (does only \par then), a priori...

  958. \newcommand*\sphinxvspacefixafterfrenchlists{%

  959.    \ifvmode\ifdim\lastskip<\z@ \vskip\parskip\fi\else\par\fi

  960. }

  961. % Holder macro for labels of literal blocks. Set-up by LaTeX writer.

  962. \newcommand*\sphinxLiteralBlockLabel {}

  963. \newcommand*\sphinxSetupCaptionForVerbatim [1]

  964. {%

  965.     \sphinxvspacefixafterfrenchlists

  966.     \needspace{\sphinxliteralblockneedspace}%

  967. % insert a \label via \sphinxLiteralBlockLabel

  968. % reset to normal the color for the literal block caption

  969.     \def\sphinxVerbatimTitle

  970.        {\py@NormalColor\sphinxcaption{\sphinxLiteralBlockLabel #1}}%

  971. }

  972. \newcommand*\sphinxSetupCodeBlockInFootnote {%

  973.   \fvset{fontsize=\footnotesize}\let\caption\sphinxfigcaption

  974.   \sphinxverbatimwithminipagetrue % reduces vertical spaces

  975.   % we counteract (this is in a group) the \@normalsize from \caption

  976.   \let\normalsize\footnotesize\let\@parboxrestore\relax

  977.   \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%

  978. }

  979. % needed to create wrapper environments of fancyvrb's Verbatim

  980. \newcommand*{\sphinxVerbatimEnvironment}{\gdef\FV@EnvironName{sphinxVerbatim}}

  981. \newcommand*{\sphinxverbatimsmallskipamount}{\smallskipamount}

  982. % serves to implement line highlighting and line wrapping

  983. \newcommand\sphinxFancyVerbFormatLine[1]{%

  984.   \expandafter\sphinx@verbatim@checkifhl\expandafter{\the\FV@CodeLineNo}%

  985.   \ifin@

  986.      \sphinxVerbatimHighlightLine{#1}%

  987.   \else

  988.      \sphinxVerbatimFormatLine{#1}%

  989.   \fi

  990. }%

  991. \newcommand\sphinxVerbatimHighlightLine[1]{%

  992.   \edef\sphinxrestorefboxsep{\fboxsep\the\fboxsep\relax}%

  993.   \fboxsep0pt\relax % cf LaTeX bug graphics/4524

  994.   \colorbox{sphinxVerbatimHighlightColor}%

  995.            {\sphinxrestorefboxsep\sphinxVerbatimFormatLine{#1}}%

  996.   % no need to restore \fboxsep here, as this ends up in a \hbox from fancyvrb

  997. }%

  998. % \sphinxVerbatimFormatLine will be set locally to one of those two:

  999. \newcommand\sphinxVerbatimFormatLineWrap[1]{%

  1000.     \hsize\linewidth

  1001.     \vtop{\raggedright\hyphenpenalty\z@\exhyphenpenalty\z@

  1002.           \doublehyphendemerits\z@\finalhyphendemerits\z@

  1003.           \strut #1\strut}%

  1004. }%

  1005. \newcommand\sphinxVerbatimFormatLineNoWrap[1]{\hb@xt@\linewidth{\strut #1\hss}}%

  1006. \g@addto@macro\FV@SetupFont{%

  1007.     \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%

  1008.     \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%

  1009. }%

  1010. \newenvironment{sphinxVerbatim}{%

  1011.   % first, let's check if there is a caption

  1012.   \ifx\sphinxVerbatimTitle\empty

  1013.       \sphinxvspacefixafterfrenchlists

  1014.       \parskip\z@skip

  1015.       \vskip\sphinxverbatimsmallskipamount

  1016.       % there was no caption. Check if nevertheless a label was set.

  1017.       \ifx\sphinxLiteralBlockLabel\empty\else

  1018.       % we require some space to be sure hyperlink target from \phantomsection

  1019.       % will not be separated from upcoming verbatim by a page break

  1020.           \needspace{\sphinxliteralblockwithoutcaptionneedspace}%

  1021.           \phantomsection\sphinxLiteralBlockLabel

  1022.       \fi

  1023.   \else

  1024.      \parskip\z@skip

  1025.      \if t\spx@opt@literalblockcappos

  1026.        \vskip\spx@abovecaptionskip

  1027.        \def\sphinxVerbatim@Before

  1028.            {\sphinxVerbatim@Title\nointerlineskip

  1029.             \kern\dimexpr-\dp\strutbox+\sphinxbelowcaptionspace\relax}%

  1030.      \else

  1031.        \vskip\sphinxverbatimsmallskipamount

  1032.        \def\sphinxVerbatim@After

  1033.           {\nointerlineskip\kern\dp\strutbox\sphinxVerbatim@Title}%

  1034.      \fi

  1035.      \def\@captype{literalblock}%

  1036.      \capstart

  1037.      % \sphinxVerbatimTitle must reset color

  1038.      \setbox\sphinxVerbatim@TitleBox

  1039.             \hbox{\begin{minipage}{\linewidth}%

  1040.                     \sphinxVerbatimTitle

  1041.                   \end{minipage}}%

  1042.   \fi

  1043.   \global\let\sphinxLiteralBlockLabel\empty

  1044.   \global\let\sphinxVerbatimTitle\empty

  1045.   \fboxsep\sphinxverbatimsep \fboxrule\sphinxverbatimborder

  1046.   \ifspx@opt@verbatimwithframe\else\fboxrule\z@\fi

  1047.   \let\FrameCommand     \sphinxVerbatim@FrameCommand

  1048.   \let\FirstFrameCommand\sphinxVerbatim@FirstFrameCommand

  1049.   \let\MidFrameCommand  \sphinxVerbatim@MidFrameCommand

  1050.   \let\LastFrameCommand \sphinxVerbatim@LastFrameCommand

  1051.   \ifspx@opt@verbatimhintsturnover\else

  1052.       \let\sphinxVerbatim@Continued\@empty

  1053.       \let\sphinxVerbatim@Continues\@empty

  1054.   \fi

  1055.   \ifspx@opt@verbatimwrapslines

  1056.   % fancyvrb's Verbatim puts each input line in (unbreakable) horizontal boxes.

  1057.   % This customization wraps each line from the input in a \vtop, thus

  1058.   % allowing it to wrap and display on two or more lines in the latex output.

  1059.   %     - The codeline counter will be increased only once.

  1060.   %     - The wrapped material will not break across pages, it is impossible

  1061.   %       to achieve this without extensive rewrite of fancyvrb.

  1062.   %     - The (not used in sphinx) obeytabs option to Verbatim is

  1063.   %       broken by this change (showtabs and tabspace work).

  1064.     \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineWrap

  1065.     \let\FV@Space\spx@verbatim@space

  1066.   % Allow breaks at special characters using \PYG... macros.

  1067.     \sphinxbreaksatspecials

  1068.   % Breaks at punctuation characters . , ; ? ! and / (needs catcode activation)

  1069.     \fvset{codes*=\sphinxbreaksviaactive}%

  1070.   \else % end of conditional code for wrapping long code lines

  1071.     \let\sphinxVerbatimFormatLine\sphinxVerbatimFormatLineNoWrap

  1072.   \fi

  1073.   \let\FancyVerbFormatLine\sphinxFancyVerbFormatLine

  1074.   % workaround to fancyvrb's check of \@currenvir

  1075.   \let\VerbatimEnvironment\sphinxVerbatimEnvironment

  1076.   % workaround to fancyvrb's check of current list depth

  1077.   \def\@toodeep {\advance\@listdepth\@ne}%

  1078.   % The list environment is needed to control perfectly the vertical space.

  1079.   % Note: \OuterFrameSep used by framed.sty is later set to \topsep hence 0pt.

  1080.   % - if caption: distance from last text baseline to caption baseline is

  1081.   %   A+(B-F)+\ht\strutbox, A = \abovecaptionskip (default 10pt), B =

  1082.   %   \baselineskip, F is the framed.sty \FrameHeightAdjust macro, default 6pt.

  1083.   %   Formula valid for F < 10pt.

  1084.   % - distance of baseline of caption to top of frame is like for tables:

  1085.   %   \sphinxbelowcaptionspace (=0.5\baselineskip)

  1086.   % - if no caption: distance of last text baseline to code frame is S+(B-F),

  1087.   %   with S = \sphinxverbatimtopskip (=\smallskip)

  1088.   % - and distance from bottom of frame to next text baseline is

  1089.   %   \baselineskip+\parskip.

  1090.   % The \trivlist is used to avoid possible "too deeply nested" error.

  1091.   \itemsep   \z@skip

  1092.   \topsep    \z@skip

  1093.   \partopsep \z@skip

  1094.   % trivlist will set \parsep to \parskip = zero

  1095.   % \leftmargin will be set to zero by trivlist

  1096.   \rightmargin\z@

  1097.   \parindent  \z@% becomes \itemindent. Default zero, but perhaps overwritten.

  1098.   \trivlist\item\relax

  1099.      \ifsphinxverbatimwithminipage\spx@inframedtrue\fi

  1100.      % use a minipage if we are already inside a framed environment

  1101.      \ifspx@inframed\noindent\begin{minipage}{\linewidth}\fi

  1102.      \MakeFramed {% adapted over from framed.sty's snugshade environment

  1103.         \advance\hsize-\width\@totalleftmargin\z@\linewidth\hsize\@setminipage

  1104.         }%

  1105.      % For grid placement from \strut's in \FancyVerbFormatLine

  1106.      \lineskip\z@skip

  1107.      % active comma should not be overwritten by \@noligs

  1108.      \ifspx@opt@verbatimwrapslines

  1109.        \let\verbatim@nolig@list \sphinx@verbatim@nolig@list

  1110.      \fi

  1111.      % will fetch its optional arguments if any

  1112.      \OriginalVerbatim

  1113. }

  1114. {%

  1115.   \endOriginalVerbatim

  1116.   \par\unskip\@minipagefalse\endMakeFramed % from framed.sty snugshade

  1117.   \ifspx@inframed\end{minipage}\fi

  1118.   \endtrivlist

  1119. }

  1120. \newenvironment {sphinxVerbatimNoFrame}

  1121.   {\spx@opt@verbatimwithframefalse

  1122.    % needed for fancyvrb as literal code will end in \end{sphinxVerbatimNoFrame}

  1123.    \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimNoFrame}}%

  1124.    \begin{sphinxVerbatim}}

  1125.   {\end{sphinxVerbatim}}

  1126. \newenvironment {sphinxVerbatimintable}

  1127.   {% don't use a frame if in a table cell

  1128.    \spx@opt@verbatimwithframefalse

  1129.    \sphinxverbatimwithminipagetrue

  1130.    % the literal block caption uses \sphinxcaption which is wrapper of \caption,

  1131.    % but \caption must be modified because longtable redefines it to work only

  1132.    % for the own table caption, and tabulary has multiple passes

  1133.    \let\caption\sphinxfigcaption

  1134.    % reduce above caption skip

  1135.    \def\spx@abovecaptionskip{\sphinxverbatimsmallskipamount}%

  1136.    \def\sphinxVerbatimEnvironment{\gdef\FV@EnvironName{sphinxVerbatimintable}}%

  1137.    \begin{sphinxVerbatim}}

  1138.   {\end{sphinxVerbatim}}

  1139. 

  1140. 

  1141. %% PARSED LITERALS

  1142. % allow long lines to wrap like they do in code-blocks

  1143. 

  1144. % this should be kept in sync with definitions in sphinx.util.texescape

  1145. \newcommand*\sphinxbreaksattexescapedchars{%

  1146.   \def\do##1##2% put potential break point before character

  1147.      {\def##1{\discretionary{}{\sphinxafterbreak\char`##2}{\char`##2}}}%

  1148.   \do\{\{\do\textless\<\do\#\#\do\%\%\do\$\$% {, <, #, %, $

  1149.   \def\do##1##2% put potential break point after character

  1150.      {\def##1{\discretionary{\char`##2}{\sphinxafterbreak}{\char`##2}}}%

  1151.   \do\_\_\do\}\}\do\textasciicircum\^\do\&\&% _, }, ^, &,

  1152.   \do\textgreater\>\do\textasciitilde\~% >, ~

  1153. }

  1154. \newcommand*\sphinxbreaksviaactiveinparsedliteral{%

  1155.   \sphinxbreaksviaactive % by default handles . , ; ? ! /

  1156.   \do\-% we need also the hyphen character (ends up "as is" in parsed-literal)

  1157.   \lccode`\~`\~ %

  1158.   % update \dospecials as it is used by \url

  1159.   % but deactivation will already have been done hence this is unneeded:

  1160.   %  \expandafter\def\expandafter\dospecials\expandafter{\dospecials

  1161.   %   \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%

  1162. }

  1163. \newcommand*\sphinxbreaksatspaceinparsedliteral{%

  1164.   \lccode`~32 \lowercase{\let~}\spx@verbatim@space\lccode`\~`\~

  1165. }

  1166. \newcommand*{\sphinxunactivateextras}{\let\do\@makeother

  1167.       \sphinxbreaksbeforeactivelist\sphinxbreaksafteractivelist\do\-}%

  1168. % the \catcode13=5\relax (deactivate end of input lines) is left to callers

  1169. \newcommand*{\sphinxunactivateextrasandspace}{\catcode32=10\relax

  1170.       \sphinxunactivateextras}%

  1171. % now for the modified alltt environment

  1172. \newenvironment{sphinxalltt}

  1173. {% at start of next line to workaround Emacs/AUCTeX issue with this file

  1174. \begin{alltt}%

  1175.  \ifspx@opt@parsedliteralwraps

  1176.    \sbox\sphinxcontinuationbox {\spx@opt@verbatimcontinued}%

  1177.    \sbox\sphinxvisiblespacebox {\spx@opt@verbatimvisiblespace}%

  1178.    \sphinxbreaksattexescapedchars

  1179.    \sphinxbreaksviaactiveinparsedliteral

  1180.    \sphinxbreaksatspaceinparsedliteral

  1181. % alltt takes care of the ' as derivative ("prime") in math mode

  1182.    \everymath\expandafter{\the\everymath\sphinxunactivateextrasandspace

  1183.              \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%

  1184. % not sure if displayed math (align,...) can end up in parsed-literal, anyway

  1185.    \everydisplay\expandafter{\the\everydisplay

  1186.              \catcode13=5 \sphinxunactivateextrasandspace

  1187.              \catcode`\<=12\catcode`\>=12\catcode`\^=7\catcode`\_=8 }%

  1188.  \fi }

  1189. {\end{alltt}}

  1190. 

  1191. % Protect \href's first argument in contexts such as sphinxalltt (or

  1192. % \sphinxcode). Sphinx uses \#, \%, \& ... always inside \sphinxhref.

  1193. \protected\def\sphinxhref#1#2{{%

  1194.     \sphinxunactivateextrasandspace % never do \scantokens with active space!

  1195.     \endlinechar\m@ne\everyeof{{#2}}% keep catcode regime for #2

  1196.     \scantokens{\href{#1}}% normalise it for #1 during \href expansion

  1197. }}

  1198. % Same for \url. And also \nolinkurl for coherence.

  1199. \protected\def\sphinxurl#1{{%

  1200.     \sphinxunactivateextrasandspace\everyeof{}% (<- precaution for \scantokens)

  1201.     \endlinechar\m@ne\scantokens{\url{#1}}%

  1202. }}

  1203. \protected\def\sphinxnolinkurl#1{{%

  1204.     \sphinxunactivateextrasandspace\everyeof{}%

  1205.     \endlinechar\m@ne\scantokens{\nolinkurl{#1}}%

  1206. }}

  1207. 

  1208. 

  1209. %% TOPIC AND CONTENTS BOXES

  1210. %

  1211. % Again based on use of "framed.sty", this allows breakable framed boxes.

  1212. \long\def\spx@ShadowFBox#1{%

  1213.   \leavevmode\begingroup

  1214.   % first we frame the box #1

  1215.   \setbox\@tempboxa

  1216.    \hbox{\vrule\@width\sphinxshadowrule

  1217.          \vbox{\hrule\@height\sphinxshadowrule

  1218.                \kern\sphinxshadowsep

  1219.                \hbox{\kern\sphinxshadowsep #1\kern\sphinxshadowsep}%

  1220.                \kern\sphinxshadowsep

  1221.                \hrule\@height\sphinxshadowrule}%

  1222.          \vrule\@width\sphinxshadowrule}%

  1223.   % Now we add the shadow, like \shadowbox from fancybox.sty would do

  1224.   \dimen@\dimexpr.5\sphinxshadowrule+\sphinxshadowsize\relax

  1225.   \hbox{\vbox{\offinterlineskip

  1226.               \hbox{\copy\@tempboxa\kern-.5\sphinxshadowrule

  1227.                     % add shadow on right side

  1228.                     \lower\sphinxshadowsize

  1229.                           \hbox{\vrule\@height\ht\@tempboxa \@width\dimen@}%

  1230.                     }%

  1231.               \kern-\dimen@ % shift back vertically to bottom of frame

  1232.               % and add shadow at bottom

  1233.               \moveright\sphinxshadowsize

  1234.                     \vbox{\hrule\@width\wd\@tempboxa \@height\dimen@}%

  1235.               }%

  1236.         % move left by the size of right shadow so shadow adds no width

  1237.         \kern-\sphinxshadowsize

  1238.        }%

  1239.   \endgroup

  1240. }

  1241. 

  1242. % use framed.sty to allow page breaks in frame+shadow

  1243. % works well inside Lists and Quote-like environments

  1244. % produced by ``topic'' directive (or local contents)

  1245. % could nest if LaTeX writer authorized it

  1246. \newenvironment{sphinxShadowBox}

  1247.   {\def\FrameCommand {\spx@ShadowFBox }%

  1248.    % configure framed.sty not to add extra vertical spacing

  1249.    \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%

  1250.    % the \trivlist will add the vertical spacing on top and bottom which is

  1251.    % typical of center environment as used in Sphinx <= 1.4.1

  1252.    % the \noindent has the effet of an extra blank line on top, to

  1253.    % imitate closely the layout from Sphinx <= 1.4.1; the \FrameHeightAdjust

  1254.    % will put top part of frame on this baseline.

  1255.    \def\FrameHeightAdjust {\baselineskip}%

  1256.    % use package footnote to handle footnotes

  1257.    \savenotes

  1258.    \trivlist\item\noindent

  1259.     % use a minipage if we are already inside a framed environment

  1260.     \ifspx@inframed\begin{minipage}{\linewidth}\fi

  1261.     \MakeFramed {\spx@inframedtrue

  1262.     % framed.sty puts into "\width" the added width (=2shadowsep+2shadowrule)

  1263.     % adjust \hsize to what the contents must use

  1264.     \advance\hsize-\width

  1265.     % adjust LaTeX parameters to behave properly in indented/quoted contexts

  1266.     \FrameRestore

  1267.     % typeset the contents as in a minipage (Sphinx <= 1.4.1 used a minipage and

  1268.     % itemize/enumerate are therein typeset more tightly, we want to keep

  1269.     % that). We copy-paste from LaTeX source code but don't do a real minipage.

  1270.     \@pboxswfalse

  1271.     \let\@listdepth\@mplistdepth \@mplistdepth\z@

  1272.     \@minipagerestore

  1273.     \@setminipage

  1274.     }%

  1275.   }%

  1276.   {% insert the "endminipage" code

  1277.     \par\unskip

  1278.     \@minipagefalse

  1279.    \endMakeFramed

  1280.      \ifspx@inframed\end{minipage}\fi

  1281.    \endtrivlist

  1282.    % output the stored footnotes

  1283.    \spewnotes

  1284.   }

  1285. 

  1286. 

  1287. %% NOTICES AND ADMONITIONS

  1288. %

  1289. % Some are quite plain

  1290. % the spx@notice@bordercolor etc are set in the sphinxadmonition environment

  1291. \newenvironment{sphinxlightbox}{%

  1292.   \par\allowbreak

  1293.   \noindent{\color{spx@notice@bordercolor}%

  1294.             \rule{\linewidth}{\spx@notice@border}}\par\nobreak

  1295.   {\parskip\z@skip\noindent}%

  1296.   }

  1297.   {%

  1298.   % counteract previous possible negative skip (French lists!):

  1299.   % (we can't cancel that any earlier \vskip introduced a potential pagebreak)

  1300.   \sphinxvspacefixafterfrenchlists

  1301.   \nobreak\vbox{\noindent\kern\@totalleftmargin

  1302.       {\color{spx@notice@bordercolor}%

  1303.        \rule[\dimexpr.4\baselineskip-\spx@notice@border\relax]

  1304.              {\linewidth}{\spx@notice@border}}\hss}\allowbreak

  1305.   }% end of sphinxlightbox environment definition

  1306. % may be renewenvironment'd by user for complete customization

  1307. \newenvironment{sphinxnote}[1]

  1308.   {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}

  1309. \newenvironment{sphinxhint}[1]

  1310.   {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}

  1311. \newenvironment{sphinximportant}[1]

  1312.   {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}

  1313. \newenvironment{sphinxtip}[1]

  1314.   {\begin{sphinxlightbox}\sphinxstrong{#1} }{\end{sphinxlightbox}}

  1315. % or just use the package options

  1316. % these are needed for common handling by notice environment of lightbox

  1317. % and heavybox but they are  currently not used by lightbox environment

  1318. % and there is consequently no corresponding package option

  1319. \definecolor{sphinxnoteBgColor}{rgb}{1,1,1}

  1320. \definecolor{sphinxhintBgColor}{rgb}{1,1,1}

  1321. \definecolor{sphinximportantBgColor}{rgb}{1,1,1}

  1322. \definecolor{sphinxtipBgColor}{rgb}{1,1,1}

  1323. 

  1324. % Others get more distinction

  1325. % Code adapted from framed.sty's "snugshade" environment.

  1326. % Nesting works (inner frames do not allow page breaks).

  1327. \newenvironment{sphinxheavybox}{\par

  1328.    \setlength{\FrameRule}{\spx@notice@border}%

  1329.    \setlength{\FrameSep}{\dimexpr.6\baselineskip-\FrameRule\relax}

  1330.    % configure framed.sty's parameters to obtain same vertical spacing

  1331.    % as for "light" boxes. We need for this to manually insert parskip glue and

  1332.    % revert a skip done by framed before the frame.

  1333.     \ltx@ifundefined{OuterFrameSep}{}{\OuterFrameSep\z@skip}%

  1334.     \vspace{\FrameHeightAdjust}

  1335.    % copied/adapted from framed.sty's snugshade

  1336.    \def\FrameCommand##1{\hskip\@totalleftmargin

  1337.        \fboxsep\FrameSep \fboxrule\FrameRule

  1338.        \fcolorbox{spx@notice@bordercolor}{spx@notice@bgcolor}{##1}%

  1339.        \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%

  1340.    \savenotes

  1341.    % use a minipage if we are already inside a framed environment

  1342.    \ifspx@inframed

  1343.        \noindent\begin{minipage}{\linewidth}

  1344.    \else

  1345.        % handle case where notice is first thing in a list item (or is quoted)

  1346.        \if@inlabel

  1347.         \noindent\par\vspace{-\baselineskip}

  1348.        \else

  1349.         \vspace{\parskip}

  1350.        \fi

  1351.    \fi

  1352.    \MakeFramed {\spx@inframedtrue

  1353.      \advance\hsize-\width \@totalleftmargin\z@ \linewidth\hsize

  1354.      % minipage initialization copied from LaTeX source code.

  1355.      \@pboxswfalse

  1356.      \let\@listdepth\@mplistdepth \@mplistdepth\z@

  1357.      \@minipagerestore

  1358.      \@setminipage }%

  1359.    }

  1360.    {%

  1361.    \par\unskip

  1362.    \@minipagefalse

  1363.    \endMakeFramed

  1364.    \ifspx@inframed\end{minipage}\fi

  1365.    % set footnotes at bottom of page

  1366.    \spewnotes

  1367.    % arrange for similar spacing below frame as for "light" boxes.

  1368.    \vskip .4\baselineskip

  1369.    }% end of sphinxheavybox environment definition

  1370. % may be renewenvironment'd by user for complete customization

  1371. \newenvironment{sphinxwarning}[1]

  1372.   {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}

  1373. \newenvironment{sphinxcaution}[1]

  1374.   {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}

  1375. \newenvironment{sphinxattention}[1]

  1376.   {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}

  1377. \newenvironment{sphinxdanger}[1]

  1378.   {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}

  1379. \newenvironment{sphinxerror}[1]

  1380.   {\begin{sphinxheavybox}\sphinxstrong{#1} }{\end{sphinxheavybox}}

  1381. % or just use package options

  1382. 

  1383. % the \colorlet of xcolor (if at all loaded) is overkill for our use case

  1384. \newcommand{\sphinxcolorlet}[2]

  1385.     {\expandafter\let\csname\@backslashchar color@#1\expandafter\endcsname

  1386.                      \csname\@backslashchar color@#2\endcsname }

  1387. 

  1388. % the main dispatch for all types of notices

  1389. \newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading

  1390.   % can't use #1 directly in definition of end part

  1391.   \def\spx@noticetype {#1}%

  1392.   % set parameters of heavybox/lightbox

  1393.   \sphinxcolorlet{spx@notice@bordercolor}{sphinx#1BorderColor}%

  1394.   \sphinxcolorlet{spx@notice@bgcolor}{sphinx#1BgColor}%

  1395.   \spx@notice@border \dimexpr\csname spx@opt@#1border\endcsname\relax

  1396.   % start specific environment, passing the heading as argument

  1397.   \begin{sphinx#1}{#2}}

  1398.   % workaround some LaTeX "feature" of \end command

  1399.  {\edef\spx@temp{\noexpand\end{sphinx\spx@noticetype}}\spx@temp}

  1400. 

  1401. 

  1402. %% PYTHON DOCS MACROS AND ENVIRONMENTS

  1403. %  (some macros here used by \maketitle in sphinxmanual.cls and sphinxhowto.cls)

  1404. 

  1405. % \moduleauthor{name}{email}

  1406. \newcommand{\moduleauthor}[2]{}

  1407. 

  1408. % \sectionauthor{name}{email}

  1409. \newcommand{\sectionauthor}[2]{}

  1410. 

  1411. % Allow the release number to be specified independently of the

  1412. % \date{}.  This allows the date to reflect the document's date and

  1413. % release to specify the release that is documented.

  1414. %

  1415. \newcommand{\py@release}{\releasename\space\version}

  1416. \newcommand{\version}{}% part of \py@release, used by title page and headers

  1417. % \releaseinfo is used on titlepage (sphinxmanual.cls, sphinxhowto.cls)

  1418. \newcommand{\releaseinfo}{}

  1419. \newcommand{\setreleaseinfo}[1]{\renewcommand{\releaseinfo}{#1}}

  1420. % this is inserted via template and #1=release config variable

  1421. \newcommand{\release}[1]{\renewcommand{\version}{#1}}

  1422. % this is defined by template to 'releasename' latex_elements key

  1423. \newcommand{\releasename}{}

  1424. % Fix issue in case release and releasename deliberately left blank

  1425. \newcommand{\sphinxheadercomma}{, }% used in fancyhdr header definition

  1426. \newcommand{\sphinxifemptyorblank}[1]{%

  1427. % test after one expansion of macro #1 if contents is empty or spaces

  1428.      \if&\expandafter\@firstofone\detokenize\expandafter{#1}&%

  1429.      \expandafter\@firstoftwo\else\expandafter\@secondoftwo\fi}%

  1430. \AtBeginDocument {%

  1431.    \sphinxifemptyorblank{\releasename}

  1432.      {\sphinxifemptyorblank{\version}{\let\sphinxheadercomma\empty}{}}

  1433.      {}%

  1434. }%

  1435. 

  1436. % Allow specification of the author's address separately from the

  1437. % author's name.  This can be used to format them differently, which

  1438. % is a good thing.

  1439. %

  1440. \newcommand{\py@authoraddress}{}

  1441. \newcommand{\authoraddress}[1]{\renewcommand{\py@authoraddress}{#1}}

  1442. 

  1443. % {fulllineitems} is the main environment for object descriptions.

  1444. %

  1445. \newcommand{\py@itemnewline}[1]{%

  1446.   \kern\labelsep

  1447.   \@tempdima\linewidth

  1448.   \advance\@tempdima \labelwidth\makebox[\@tempdima][l]{#1}%

  1449.   \kern-\labelsep

  1450. }

  1451. 

  1452. \newenvironment{fulllineitems}{%

  1453.   \begin{list}{}{\labelwidth \leftmargin

  1454.                  \rightmargin \z@ \topsep -\parskip \partopsep \parskip

  1455.                  \itemsep -\parsep

  1456.                  \let\makelabel=\py@itemnewline}%

  1457. }{\end{list}}

  1458. 

  1459. % Signatures, possibly multi-line

  1460. %

  1461. \newlength{\py@argswidth}

  1462. \newcommand{\py@sigparams}[2]{%

  1463.   \parbox[t]{\py@argswidth}{#1\sphinxcode{)}#2}}

  1464. \newcommand{\pysigline}[1]{\item[{#1}]}

  1465. \newcommand{\pysiglinewithargsret}[3]{%

  1466.   \settowidth{\py@argswidth}{#1\sphinxcode{(}}%

  1467.   \addtolength{\py@argswidth}{-2\py@argswidth}%

  1468.   \addtolength{\py@argswidth}{\linewidth}%

  1469.   \item[{#1\sphinxcode{(}\py@sigparams{#2}{#3}}]}

  1470. \newcommand{\pysigstartmultiline}{%

  1471.  \def\pysigstartmultiline{\vskip\smallskipamount\parskip\z@skip\itemsep\z@skip}%

  1472.  \edef\pysigstopmultiline

  1473.      {\noexpand\leavevmode\parskip\the\parskip\relax\itemsep\the\itemsep\relax}%

  1474.  \parskip\z@skip\itemsep\z@skip

  1475. }

  1476. 

  1477. % Production lists

  1478. %

  1479. \newenvironment{productionlist}{%

  1480. %  \def\sphinxoptional##1{{\Large[}##1{\Large]}}

  1481.   \def\production##1##2{\\\sphinxcode{\sphinxupquote{##1}}&::=&\sphinxcode{\sphinxupquote{##2}}}%

  1482.   \def\productioncont##1{\\& &\sphinxcode{\sphinxupquote{##1}}}%

  1483.   \parindent=2em

  1484.   \indent

  1485.   \setlength{\LTpre}{0pt}%

  1486.   \setlength{\LTpost}{0pt}%

  1487.   \begin{longtable}[l]{lcl}

  1488. }{%

  1489.   \end{longtable}

  1490. }

  1491. 

  1492. % Definition lists; requested by AMK for HOWTO documents.  Probably useful

  1493. % elsewhere as well, so keep in in the general style support.

  1494. %

  1495. \newenvironment{definitions}{%

  1496.   \begin{description}%

  1497.   \def\term##1{\item[{##1}]\mbox{}\\*[0mm]}%

  1498. }{%

  1499.   \end{description}%

  1500. }

  1501. 

  1502. %% FROM DOCTUTILS LATEX WRITER

  1503. %

  1504. % The following is stuff copied from docutils' latex writer.

  1505. %

  1506. \newcommand{\optionlistlabel}[1]{\normalfont\bfseries #1 \hfill}% \bf deprecated

  1507. \newenvironment{optionlist}[1]

  1508. {\begin{list}{}

  1509.   {\setlength{\labelwidth}{#1}

  1510.    \setlength{\rightmargin}{1cm}

  1511.    \setlength{\leftmargin}{\rightmargin}

  1512.    \addtolength{\leftmargin}{\labelwidth}

  1513.    \addtolength{\leftmargin}{\labelsep}

  1514.    \renewcommand{\makelabel}{\optionlistlabel}}

  1515. }{\end{list}}

  1516. 

  1517. \newlength{\lineblockindentation}

  1518. \setlength{\lineblockindentation}{2.5em}

  1519. \newenvironment{lineblock}[1]

  1520. {\begin{list}{}

  1521.   {\setlength{\partopsep}{\parskip}

  1522.    \addtolength{\partopsep}{\baselineskip}

  1523.    \topsep0pt\itemsep0.15\baselineskip\parsep0pt

  1524.    \leftmargin#1\relax}

  1525.  \raggedright}

  1526. {\end{list}}

  1527. 

  1528. % From docutils.writers.latex2e

  1529. % inline markup (custom roles)

  1530. % \DUrole{#1}{#2} tries \DUrole#1{#2}

  1531. \providecommand*{\DUrole}[2]{%

  1532.   \ifcsname DUrole\detokenize{#1}\endcsname

  1533.     \csname DUrole\detokenize{#1}\endcsname{#2}%

  1534.   \else% backwards compatibility: try \docutilsrole#1{#2}

  1535.     \ifcsname docutilsrole\detokenize{#1}\endcsname

  1536.       \csname docutilsrole\detokenize{#1}\endcsname{#2}%

  1537.     \else

  1538.       #2%

  1539.     \fi

  1540.   \fi

  1541. }

  1542. 

  1543. \providecommand*{\DUprovidelength}[2]{%

  1544.   \ifdefined#1\else\newlength{#1}\setlength{#1}{#2}\fi

  1545. }

  1546. 

  1547. \DUprovidelength{\DUlineblockindent}{2.5em}

  1548. \ifdefined\DUlineblock\else

  1549.   \newenvironment{DUlineblock}[1]{%

  1550.     \list{}{\setlength{\partopsep}{\parskip}

  1551.             \addtolength{\partopsep}{\baselineskip}

  1552.             \setlength{\topsep}{0pt}

  1553.             \setlength{\itemsep}{0.15\baselineskip}

  1554.             \setlength{\parsep}{0pt}

  1555.             \setlength{\leftmargin}{#1}}

  1556.     \raggedright

  1557.   }

  1558.   {\endlist}

  1559. \fi

  1560. 

  1561. %% TEXT STYLING

  1562. %

  1563. % to obtain straight quotes we execute \@noligs as patched by upquote, and

  1564. % \scantokens is needed in cases where it would be too late for the macro to

  1565. % first set catcodes and then fetch its argument. We also make the contents

  1566. % breakable at non-escaped . , ; ? ! / using \sphinxbreaksviaactive.

  1567. % the macro must be protected if it ends up used in moving arguments,

  1568. % in 'alltt' \@noligs is done already, and the \scantokens must be avoided.

  1569. \protected\def\sphinxupquote#1{{\def\@tempa{alltt}%

  1570.   \ifx\@tempa\@currenvir\else

  1571.    \ifspx@opt@inlineliteralwraps

  1572.       \sphinxbreaksviaactive\let\sphinxafterbreak\empty

  1573.       % do not overwrite the comma set-up

  1574.       \let\verbatim@nolig@list\sphinx@literal@nolig@list

  1575.    \fi

  1576.    % fix a space-gobbling issue due to LaTeX's original \do@noligs

  1577.    \let\do@noligs\sphinx@do@noligs

  1578.    \@noligs\endlinechar\m@ne\everyeof{}% (<- in case inside \sphinxhref)

  1579.    \expandafter\scantokens

  1580.   \fi {{#1}}}}% extra brace pair to fix end-space gobbling issue...

  1581. \def\sphinx@do@noligs #1{\catcode`#1\active\begingroup\lccode`\~`#1\relax

  1582.     \lowercase{\endgroup\def~{\leavevmode\kern\z@\char`#1 }}}

  1583. \def\sphinx@literal@nolig@list {\do\`\do\<\do\>\do\'\do\-}%

  1584. 

  1585. % Some custom font markup commands.

  1586. \protected\def\sphinxstrong#1{\textbf{#1}}

  1587. \protected\def\sphinxcode#1{\texttt{#1}}

  1588. \protected\def\sphinxbfcode#1{\textbf{\sphinxcode{#1}}}

  1589. \protected\def\sphinxemail#1{\textsf{#1}}

  1590. \protected\def\sphinxtablecontinued#1{\textsf{#1}}

  1591. \protected\def\sphinxtitleref#1{\emph{#1}}

  1592. \protected\def\sphinxmenuselection#1{\emph{#1}}

  1593. \protected\def\sphinxguilabel#1{\emph{#1}}

  1594. \protected\def\sphinxaccelerator#1{\underline{#1}}

  1595. \protected\def\sphinxcrossref#1{\emph{#1}}

  1596. \protected\def\sphinxtermref#1{\emph{#1}}

  1597. % \optional is used for ``[, arg]``, i.e. desc_optional nodes.

  1598. \long\protected\def\sphinxoptional#1{%

  1599.   {\textnormal{\Large[}}{#1}\hspace{0.5mm}{\textnormal{\Large]}}}

  1600. 

  1601. % additional customizable styling

  1602. \def\sphinxstyleindexentry   #1{\texttt{#1}}

  1603. \def\sphinxstyleindexextra   #1{ \emph{(#1)}}

  1604. \def\sphinxstyleindexpageref #1{, \pageref{#1}}

  1605. \def\sphinxstyleindexlettergroup #1%

  1606.     {{\Large\sffamily#1}\nopagebreak\vspace{1mm}}

  1607. \def\sphinxstyleindexlettergroupDefault #1%

  1608.     {{\Large\sffamily\sphinxnonalphabeticalgroupname}\nopagebreak\vspace{1mm}}

  1609. \protected\def\sphinxstyletopictitle   #1{\textbf{#1}\par\medskip}

  1610. \let\sphinxstylesidebartitle\sphinxstyletopictitle

  1611. \protected\def\sphinxstyleothertitle   #1{\textbf{#1}}

  1612. \protected\def\sphinxstylesidebarsubtitle #1{~\\\textbf{#1} \smallskip}

  1613. % \text.. commands do not allow multiple paragraphs

  1614. \protected\def\sphinxstyletheadfamily    {\sffamily}

  1615. \protected\def\sphinxstyleemphasis     #1{\emph{#1}}

  1616. \protected\def\sphinxstyleliteralemphasis#1{\emph{\sphinxcode{#1}}}

  1617. \protected\def\sphinxstylestrong       #1{\textbf{#1}}

  1618. \protected\def\sphinxstyleliteralstrong#1{\sphinxbfcode{#1}}

  1619. \protected\def\sphinxstyleabbreviation #1{\textsc{#1}}

  1620. \protected\def\sphinxstyleliteralintitle#1{\sphinxcode{#1}}

  1621. \newcommand*\sphinxstylecodecontinued[1]{\footnotesize(#1)}%

  1622. \newcommand*\sphinxstylecodecontinues[1]{\footnotesize(#1)}%

  1623. % figure legend comes after caption and may contain arbitrary body elements

  1624. \newenvironment{sphinxlegend}{\par\small}{\par}

  1625. % reduce hyperref "Token not allowed in a PDF string" warnings on PDF builds

  1626. \AtBeginDocument{\pdfstringdefDisableCommands{%

  1627. % all "protected" macros possibly ending up in section titles should be here

  1628.     \let\sphinxstyleemphasis        \@firstofone

  1629.     \let\sphinxstyleliteralemphasis \@firstofone

  1630.     \let\sphinxstylestrong          \@firstofone

  1631.     \let\sphinxstyleliteralstrong   \@firstofone

  1632.     \let\sphinxstyleabbreviation    \@firstofone

  1633.     \let\sphinxstyleliteralintitle  \@firstofone

  1634.     \let\sphinxupquote  \@firstofone

  1635.     \let\sphinxstrong   \@firstofone

  1636.     \let\sphinxcode     \@firstofone

  1637.     \let\sphinxbfcode   \@firstofone

  1638.     \let\sphinxemail    \@firstofone

  1639.     \let\sphinxcrossref \@firstofone

  1640.     \let\sphinxtermref  \@firstofone

  1641. }}

  1642. 

  1643. % For curly braces inside \index macro

  1644. \def\sphinxleftcurlybrace{\{}

  1645. \def\sphinxrightcurlybrace{\}}

  1646. 

  1647. % Declare Unicode characters used by linux tree command to pdflatex utf8/utf8x

  1648. \def\spx@bd#1#2{%

  1649.   \leavevmode

  1650.   \begingroup

  1651.   \ifx\spx@bd@height   \@undefined\def\spx@bd@height{\baselineskip}\fi

  1652.   \ifx\spx@bd@width    \@undefined\setbox0\hbox{0}\def\spx@bd@width{\wd0 }\fi

  1653.   \ifx\spx@bd@thickness\@undefined\def\spx@bd@thickness{.6\p@}\fi

  1654.   \ifx\spx@bd@lower    \@undefined\def\spx@bd@lower{\dp\strutbox}\fi

  1655.   \lower\spx@bd@lower#1{#2}%

  1656.   \endgroup

  1657. }%

  1658. \@namedef{sphinx@u2500}% BOX DRAWINGS LIGHT HORIZONTAL

  1659.   {\spx@bd{\vbox to\spx@bd@height}

  1660.           {\vss\hrule\@height\spx@bd@thickness

  1661.                      \@width\spx@bd@width\vss}}%

  1662. \@namedef{sphinx@u2502}% BOX DRAWINGS LIGHT VERTICAL

  1663.   {\spx@bd{\hb@xt@\spx@bd@width}

  1664.           {\hss\vrule\@height\spx@bd@height

  1665.                      \@width \spx@bd@thickness\hss}}%

  1666. \@namedef{sphinx@u2514}% BOX DRAWINGS LIGHT UP AND RIGHT

  1667.   {\spx@bd{\hb@xt@\spx@bd@width}

  1668.           {\hss\raise.5\spx@bd@height

  1669.            \hb@xt@\z@{\hss\vrule\@height.5\spx@bd@height

  1670.                                 \@width \spx@bd@thickness\hss}%

  1671.            \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness

  1672.                                             \@width.5\spx@bd@width\vss}}}%

  1673. \@namedef{sphinx@u251C}% BOX DRAWINGS LIGHT VERTICAL AND RIGHT

  1674.   {\spx@bd{\hb@xt@\spx@bd@width}

  1675.           {\hss

  1676.            \hb@xt@\z@{\hss\vrule\@height\spx@bd@height

  1677.                                 \@width \spx@bd@thickness\hss}%

  1678.            \vbox to\spx@bd@height{\vss\hrule\@height\spx@bd@thickness

  1679.                                             \@width.5\spx@bd@width\vss}}}%

  1680. \protected\def\sphinxunichar#1{\@nameuse{sphinx@u#1}}%

  1681. 

  1682. % Tell TeX about pathological hyphenation cases:

  1683. \hyphenation{Base-HTTP-Re-quest-Hand-ler}

  1684. \endinput