Merge branch '5.x'

# Conflicts:
#	.github/workflows/main.yml
#	CHANGES
#	sphinx/__init__.py
#	sphinx/domains/c.py
This commit is contained in:
Adam Turner
2022-10-16 11:24:18 +01:00
76 changed files with 2100 additions and 590 deletions

View File

@@ -17,6 +17,8 @@ https://github.com/octocat
`replaceable link`_
`non replaceable link <https://github.com/sphinx-doc/sphinx/pulls>`_
.. hyperlinks
.. _replaceable link: https://github.com/octocat

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View File

@@ -0,0 +1,5 @@
Sphinx image handling
=====================
.. an image with a character that is valid in a local file path but not a URL
.. image:: img_#1.png

View File

@@ -4,6 +4,27 @@ complex tables
grid table
----------
.. rst-class:: nocolorrows
+---------+---------+---------+
| header1 | header2 | header3 |
+=========+=========+=========+
| cell1-1 | cell1-2 | cell1-3 |
+---------+ +---------+
| cell2-1 | | cell2-3 |
+ +---------+---------+
| | cell3-2-par1 |
+---------+ |
| cell4-1 | cell3-2-par2 |
+---------+---------+---------+
| cell5-1 |
+---------+---------+---------+
grid table with tabularcolumns having no vline
----------------------------------------------
.. tabularcolumns:: TTT
+---------+---------+---------+
| header1 | header2 | header3 |
+=========+=========+=========+
@@ -26,6 +47,8 @@ table having ...
* consecutive multirow at top of row (1-1 and 1-2)
* consecutive multirow at end of row (1-4 and 1-5)
.. rst-class:: standard
+-----------+-----------+-----------+-----------+-----------+
| | | cell1-3 | | |
| | +-----------+ | cell1-5 |

View File

@@ -14,10 +14,12 @@ consecutive multirow at end of row (1\sphinxhyphen{}4 and 1\sphinxhyphen{}5)
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithstandardstyle
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|T|T|}
\hline
\sphinxmultirow{3}{1}{%
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxmultirow{3}{1}{%
\begin{varwidth}[t]{\sphinxcolwidth{1}{5}}
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -49,7 +51,7 @@ cell1\sphinxhyphen{}5
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
}%
\\
\cline{3-3}\sphinxtablestrut{1}&\sphinxtablestrut{2}&\sphinxmultirow{2}{6}{%
\sphinxvlinecrossing{1}\sphinxcline{3-3}\sphinxvlinecrossing{4}\sphinxfixclines{5}\sphinxtablestrut{1}&\sphinxtablestrut{2}&\sphinxmultirow{2}{6}{%
\begin{varwidth}[t]{\sphinxcolwidth{1}{5}}
\sphinxAtStartPar
cell2\sphinxhyphen{}3
@@ -57,11 +59,11 @@ cell2\sphinxhyphen{}3
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
}%
&\sphinxtablestrut{4}&\sphinxtablestrut{5}\\
\cline{5-5}\sphinxtablestrut{1}&\sphinxtablestrut{2}&\sphinxtablestrut{6}&\sphinxtablestrut{4}&
\sphinxvlinecrossing{1}\sphinxvlinecrossing{2}\sphinxvlinecrossing{3}\sphinxcline{5-5}\sphinxfixclines{5}\sphinxtablestrut{1}&\sphinxtablestrut{2}&\sphinxtablestrut{6}&\sphinxtablestrut{4}&
\sphinxAtStartPar
cell3\sphinxhyphen{}5
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,11 @@
\label{\detokenize{complex:grid-table}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithnocolorrowsstyle
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|T|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -14,7 +16,8 @@ header2
\sphinxAtStartPar
header3
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&\sphinxmultirow{2}{5}{%
@@ -28,7 +31,7 @@ cell1\sphinxhyphen{}2
\sphinxAtStartPar
cell1\sphinxhyphen{}3
\\
\cline{1-1}\cline{3-3}\sphinxmultirow{2}{7}{%
\sphinxcline{1-1}\sphinxcline{3-3}\sphinxfixclines{3}\sphinxmultirow{2}{7}{%
\begin{varwidth}[t]{\sphinxcolwidth{1}{3}}
\sphinxAtStartPar
cell2\sphinxhyphen{}1
@@ -39,7 +42,7 @@ cell2\sphinxhyphen{}1
\sphinxAtStartPar
cell2\sphinxhyphen{}3
\\
\cline{2-3}\sphinxtablestrut{7}&\sphinxstartmulticolumn{2}%
\sphinxcline{2-3}\sphinxfixclines{3}\sphinxtablestrut{7}&\sphinxstartmulticolumn{2}%
\sphinxmultirow{2}{9}{%
\begin{varwidth}[t]{\sphinxcolwidth{2}{3}}
\sphinxAtStartPar
@@ -52,11 +55,11 @@ cell3\sphinxhyphen{}2\sphinxhyphen{}par2
}%
\sphinxstopmulticolumn
\\
\cline{1-1}
\sphinxcline{1-1}\sphinxfixclines{3}
\sphinxAtStartPar
cell4\sphinxhyphen{}1
&\multicolumn{2}{l|}{\sphinxtablestrut{9}}\\
\hline\sphinxstartmulticolumn{3}%
\sphinxhline\sphinxstartmulticolumn{3}%
\begin{varwidth}[t]{\sphinxcolwidth{3}{3}}
\sphinxAtStartPar
cell5\sphinxhyphen{}1
@@ -64,7 +67,7 @@ cell5\sphinxhyphen{}1
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
\sphinxstopmulticolumn
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -0,0 +1,73 @@
\label{\detokenize{complex:grid-table-with-tabularcolumns-having-no-vline}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithnovlinesstyle
\centering
\begin{tabulary}{\linewidth}[t]{TTT}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
&\sphinxstyletheadfamily
\sphinxAtStartPar
header2
&\sphinxstyletheadfamily
\sphinxAtStartPar
header3
\\
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&\sphinxmultirow{2}{5}{%
\begin{varwidth}[t]{\sphinxcolwidth{1}{3}}
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\par
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
}%
&
\sphinxAtStartPar
cell1\sphinxhyphen{}3
\\
\sphinxcline{1-1}\sphinxcline{3-3}\sphinxfixclines{3}\sphinxmultirow{2}{7}{%
\begin{varwidth}[t]{\sphinxcolwidth{1}{3}}
\sphinxAtStartPar
cell2\sphinxhyphen{}1
\par
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
}%
&\sphinxtablestrut{5}&
\sphinxAtStartPar
cell2\sphinxhyphen{}3
\\
\sphinxcline{2-3}\sphinxfixclines{3}\sphinxtablestrut{7}&\sphinxstartmulticolumn{2}%
\sphinxmultirow{2}{9}{%
\begin{varwidth}[t]{\sphinxcolwidth{2}{3}}
\sphinxAtStartPar
cell3\sphinxhyphen{}2\sphinxhyphen{}par1
\sphinxAtStartPar
cell3\sphinxhyphen{}2\sphinxhyphen{}par2
\par
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
}%
\sphinxstopmulticolumn
\\
\sphinxcline{1-1}\sphinxfixclines{3}
\sphinxAtStartPar
cell4\sphinxhyphen{}1
&\multicolumn{2}{l}{\sphinxtablestrut{9}}\\
\sphinxhline\sphinxstartmulticolumn{3}%
\begin{varwidth}[t]{\sphinxcolwidth{3}{3}}
\sphinxAtStartPar
cell5\sphinxhyphen{}1
\par
\vskip-\baselineskip\vbox{\hbox{\strut}}\end{varwidth}%
\sphinxstopmulticolumn
\\
\sphinxbottomrule
\end{tabulary}
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,7 +1,11 @@
\label{\detokenize{longtable:longtable}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|l|l|}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithborderlessstyle
\begin{longtable}[c]{ll}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +13,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +27,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -37,19 +45,22 @@ cell1\sphinxhyphen{}1
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,10 @@
\label{\detokenize{longtable:longtable-having-align-option}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[r]{|l|l|}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[r]{|l|l|}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +12,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +26,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -37,19 +44,22 @@ cell1\sphinxhyphen{}1
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,9 +1,12 @@
\label{\detokenize{longtable:longtable-having-caption}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|l|l|}
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|l|l|}
\sphinxthelongtablecaptionisattop
\caption{caption for longtable\strut}\label{\detokenize{longtable:id1}}\\*[\sphinxlongtablecapskipadjust]
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,12 +14,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -24,14 +28,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -39,19 +46,22 @@ cell1\sphinxhyphen{}1
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,10 @@
\label{\detokenize{longtable:longtable-having-problematic-cell}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|*{2}{\X{1}{2}|}}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|*{2}{\X{1}{2}|}}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +12,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +26,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\begin{itemize}
\item {}
\sphinxAtStartPar
@@ -44,19 +51,22 @@ item2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,10 @@
\label{\detokenize{longtable:longtable-having-both-stub-columns-and-problematic-cell}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|*{3}{\X{1}{3}|}}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|*{3}{\X{1}{3}|}}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -12,12 +15,13 @@ header2
\sphinxAtStartPar
header3
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{3}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{3}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -28,14 +32,17 @@ header2
\sphinxAtStartPar
header3
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{3}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{3}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxstyletheadfamily \begin{itemize}
\item {}
\sphinxAtStartPar
@@ -53,7 +60,7 @@ instub1\sphinxhyphen{}2
\sphinxAtStartPar
notinstub1\sphinxhyphen{}3
\\
\hline\sphinxstyletheadfamily
\sphinxhline\sphinxstyletheadfamily
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&\sphinxstyletheadfamily
@@ -63,5 +70,8 @@ cell2\sphinxhyphen{}2
\sphinxAtStartPar
cell2\sphinxhyphen{}3
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,10 @@
\label{\detokenize{longtable:longtable-having-verbatim}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|*{2}{\X{1}{2}|}}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|*{2}{\X{1}{2}|}}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +12,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +26,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\begin{sphinxVerbatimintable}[commandchars=\\\{\}]
\PYG{n}{hello} \PYG{n}{world}
@@ -38,19 +45,22 @@ header2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,11 @@
\label{\detokenize{longtable:longtable-having-widths-option}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|\X{30}{100}|\X{70}{100}|}
\hline\noalign{\phantomsection\label{\detokenize{longtable:namedlongtable}}\label{\detokenize{longtable:mylongtable}}}%
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|\X{30}{100}|\X{70}{100}|}
\noalign{\phantomsection\label{\detokenize{longtable:namedlongtable}}\label{\detokenize{longtable:mylongtable}}}%
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +13,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +27,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -37,22 +45,25 @@ cell1\sphinxhyphen{}1
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}
\sphinxAtStartPar
See {\hyperref[\detokenize{longtable:mylongtable}]{\sphinxcrossref{mylongtable}}}, same as {\hyperref[\detokenize{longtable:namedlongtable}]{\sphinxcrossref{\DUrole{std,std-ref}{this one}}}}.

View File

@@ -1,7 +1,10 @@
\label{\detokenize{longtable:longtable-having-both-widths-and-problematic-cell}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|\X{30}{100}|\X{70}{100}|}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\begin{longtable}[c]{|\X{30}{100}|\X{70}{100}|}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +12,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +26,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\begin{itemize}
\item {}
\sphinxAtStartPar
@@ -44,19 +51,22 @@ item2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,7 +1,11 @@
\label{\detokenize{longtable:longtable-with-tabularcolumn}}
\begin{savenotes}\sphinxatlongtablestart\begin{longtable}[c]{|c|c|}
\hline
\begin{savenotes}
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithvlinesstyle
\begin{longtable}[c]{|c|c|}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -9,12 +13,13 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endfirsthead
\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline
\multicolumn{2}{c}{\sphinxnorowcolor
\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -22,14 +27,17 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\endhead
\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot
\endlastfoot
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
@@ -37,19 +45,22 @@ cell1\sphinxhyphen{}1
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\end{longtable}\sphinxatlongtableend\end{savenotes}
\sphinxbottomrule
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:simple-table}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,28 +12,29 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,13 +1,14 @@
\label{\detokenize{tabular:table-having-caption}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\sphinxcapstartof{table}
\sphinxthecaptionisattop
\sphinxcaption{caption for table}\label{\detokenize{tabular:id1}}
\sphinxaftertopcaption
\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -15,28 +16,29 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-problematic-cell}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabular}[t]{|*{2}{\X{1}{2}|}}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,7 +12,8 @@ header1
\sphinxAtStartPar
header2
\\
\hline\begin{itemize}
\sphinxmidrule
\sphinxtableatstartofbodyhook\begin{itemize}
\item {}
\sphinxAtStartPar
item1
@@ -25,21 +27,21 @@ item2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-both-stub-columns-and-problematic-cell}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabular}[t]{|*{3}{\X{1}{3}|}}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -14,7 +15,8 @@ header2
\sphinxAtStartPar
header3
\\
\hline\sphinxstyletheadfamily \begin{itemize}
\sphinxmidrule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily \begin{itemize}
\item {}
\sphinxAtStartPar
instub1\sphinxhyphen{}1a
@@ -31,7 +33,7 @@ instub1\sphinxhyphen{}2
\sphinxAtStartPar
notinstub1\sphinxhyphen{}3
\\
\hline\sphinxstyletheadfamily
\sphinxhline\sphinxstyletheadfamily
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&\sphinxstyletheadfamily
@@ -41,7 +43,7 @@ cell2\sphinxhyphen{}2
\sphinxAtStartPar
cell2\sphinxhyphen{}3
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,14 +1,16 @@
\label{\detokenize{tabular:table-with-cell-in-first-column-having-three-paragraphs}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabulary}{\linewidth}[t]{|T|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1\sphinxhyphen{}par1
@@ -18,7 +20,7 @@ cell1\sphinxhyphen{}1\sphinxhyphen{}par2
\sphinxAtStartPar
cell1\sphinxhyphen{}1\sphinxhyphen{}par3
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-verbatim}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabular}[t]{|*{2}{\X{1}{2}|}}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,7 +12,8 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\begin{sphinxVerbatimintable}[commandchars=\\\{\}]
\PYG{n}{hello} \PYG{n}{world}
\end{sphinxVerbatimintable}
@@ -19,21 +21,21 @@ header2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,10 +1,13 @@
\label{\detokenize{tabular:table-having-widths-option}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithbooktabsstyle
\sphinxthistablewithcolorrowsstyle
\centering
\phantomsection\label{\detokenize{tabular:namedtabular}}\label{\detokenize{tabular:mytabular}}\nobreak
\begin{tabular}[t]{|\X{30}{100}|\X{70}{100}|}
\hline
\begin{tabular}[t]{\X{30}{100}\X{70}{100}}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -12,30 +15,31 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}
\sphinxAtStartPar

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-both-widths-and-problematic-cell}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\centering
\begin{tabular}[t]{|\X{30}{100}|\X{70}{100}|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,7 +12,8 @@ header1
\sphinxAtStartPar
header2
\\
\hline\begin{itemize}
\sphinxmidrule
\sphinxtableatstartofbodyhook\begin{itemize}
\item {}
\sphinxAtStartPar
item1
@@ -25,21 +27,21 @@ item2
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-align-option-tabular}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\raggedright
\begin{tabular}[t]{|\X{30}{100}|\X{70}{100}|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,28 +12,29 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabular}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,11 @@
\label{\detokenize{tabular:table-with-tabularcolumn}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithnovlinesstyle
\centering
\begin{tabulary}{\linewidth}[t]{|c|c|}
\hline
\begin{tabulary}{\linewidth}[t]{cc}
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,28 +13,29 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -1,9 +1,10 @@
\label{\detokenize{tabular:table-having-align-option-tabulary}}
\begin{savenotes}\sphinxattablestart
\sphinxthistablewithglobalstyle
\raggedleft
\begin{tabulary}{\linewidth}[t]{|T|T|}
\hline
\sphinxtoprule
\sphinxstyletheadfamily
\sphinxAtStartPar
header1
@@ -11,28 +12,29 @@ header1
\sphinxAtStartPar
header2
\\
\hline
\sphinxmidrule
\sphinxtableatstartofbodyhook
\sphinxAtStartPar
cell1\sphinxhyphen{}1
&
\sphinxAtStartPar
cell1\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell2\sphinxhyphen{}1
&
\sphinxAtStartPar
cell2\sphinxhyphen{}2
\\
\hline
\sphinxhline
\sphinxAtStartPar
cell3\sphinxhyphen{}1
&
\sphinxAtStartPar
cell3\sphinxhyphen{}2
\\
\hline
\sphinxbottomrule
\end{tabulary}
\par
\sphinxtableafterendhook\par
\sphinxattableend\end{savenotes}

View File

@@ -5,7 +5,7 @@ longtable
---------
.. table::
:class: longtable
:class: longtable, borderless
======= =======
header1 header2

View File

@@ -20,6 +20,7 @@ table having :widths: option
.. table::
:widths: 30,70
:name: namedtabular
:class: booktabs, colorrows
======= =======
header1 header2
@@ -63,7 +64,7 @@ table having :align: option (tabular)
table with tabularcolumn
------------------------
.. tabularcolumns:: |c|c|
.. tabularcolumns:: cc
======= =======
header1 header2

View File

@@ -0,0 +1,6 @@
.. py:function:: func()
Overview
--------
Lorem ipsum dolar sit amet

View File

@@ -214,7 +214,8 @@ Test repeated option directive.
My secret API.
Reference the first option :option:`-mapi=secret`.
Reference the first option :option:`-mapi=secret`, :option:`-mapi[=xxx]`
or :option:`-mapi with_space`.
User markup