<% set tilde = "~" if sphinx_version < (4, 4) else "" -%>
<%- set hline = "\\sphinxhline" if sphinx_version >= (5, 3) else "\\hline" -%>
<%- set par = "\\sphinxtableafterendhook\\par" if sphinx_version >= (5, 3) else "\\par" -%>
<%- set sphinxparam = "sphinxparam" if sphinx_version >= (6, 2) else "emph" -%>
<%- if sphinx_version >= (7, 1) -%>
<%- set sphinxparamcomma = "\\sphinxparamcomma \\sphinxparam" -%>
<%- elif sphinx_version >= (6, 2) -%>
<%- set sphinxparamcomma = ", \\sphinxparam" -%>
<%- else -%>
<%- set sphinxparamcomma = ", \\emph" -%>
<%- endif -%>
<%- set du_role_2nd_n = ",n" if (7, 2) > sphinx_version >= (6, 2) else "" -%>
<# Latest Sphinx removed vertical rules from csv-table. Inconsequential for us #>
<%- set regex_columns = "TT" if sphinx_version >= (6, 0) else "|T|T|" -%>
<%- set sphinx81_linebreak = "\n" if sphinx_version >= (8, 1) else "" -%>
<%- macro versionadded(v) -%>
<%- if sphinx_version >= (8, 1) %>\DUrole{versionmodified}{\DUrole{added}{Added in version <<v>>.}}
<%- else %>\DUrole{versionmodified,added}{<% if sphinx_version >= (7, 3) %>Added<% else %>New<% endif %> in version <<v>>.}<% endif %>
<%- endmacro -%>
<%- macro versionremoved(v) -%>
<%- if sphinx_version >= (8, 1) %>\DUrole{versionmodified}{\DUrole{removed}{Removed in version <<v>>: }}
<%- else %>\DUrole{versionmodified,removed}{Removed in version <<v>>: }
<%- endif %><%- endmacro -%>
<%- macro versionchanged(v) -%>
<%- if sphinx_version >= (8, 1) %>\DUrole{versionmodified}{\DUrole{changed}{Changed in version <<v>>: }}
<%- else %>\DUrole{versionmodified,changed}{Changed in version <<v>>: }
<%- endif %><%- endmacro -%>
%% Generated by Sphinx.
\def\sphinxdocclass{report}
\documentclass[letterpaper,10pt,english]{sphinxmanual}
\ifdefined\pdfpxdimen
   \let\sphinxpxdimen\pdfpxdimen\else\newdimen\sphinxpxdimen
\fi \sphinxpxdimen=.75bp\relax
<% if sphinx_version >= (4, 0) %>\ifdefined\pdfimageresolution
    \pdfimageresolution= \numexpr \dimexpr1in\relax/\sphinxpxdimen\relax
\fi
%% let collapsable pdf bookmarks panel have high depth per default
\PassOptionsToPackage{bookmarksdepth=5}{hyperref}<% if sphinx_version >= (5, 3) %>
<% endif %><% if sphinx_version >= (6, 0) %>
\PassOptionsToPackage{booktabs}{sphinx}
\PassOptionsToPackage{colorrows}{sphinx}<% endif %>
<% endif %>
\PassOptionsToPackage{warn}{textcomp}
\usepackage[utf8]{inputenc}
\ifdefined\DeclareUnicodeCharacter
% support both utf8 and utf8x syntaxes
  \ifdefined\DeclareUnicodeCharacterAsOptional
    \def\sphinxDUC#1{\DeclareUnicodeCharacter{"#1}}
  \else
    \let\sphinxDUC\DeclareUnicodeCharacter
  \fi
  \sphinxDUC{00A0}{\nobreakspace}
  \sphinxDUC{2500}{\sphinxunichar{2500}}
  \sphinxDUC{2502}{\sphinxunichar{2502}}
  \sphinxDUC{2514}{\sphinxunichar{2514}}
  \sphinxDUC{251C}{\sphinxunichar{251C}}
  \sphinxDUC{2572}{\textbackslash}
\fi
\usepackage{cmap}
\usepackage[T1]{fontenc}
\usepackage{amsmath,amssymb,amstext}
\usepackage{babel}

<%+ if sphinx_version >= (4, 0) %>

\usepackage{tgtermes}
\usepackage{tgheros}
\renewcommand{\ttdefault}{txtt}

<% else %>

\usepackage{times}
\expandafter\ifx\csname T@LGR\endcsname\relax
\else
% LGR was declared as font encoding
  \substitutefont{LGR}{\rmdefault}{cmr}
  \substitutefont{LGR}{\sfdefault}{cmss}
  \substitutefont{LGR}{\ttdefault}{cmtt}
\fi
\expandafter\ifx\csname T@X2\endcsname\relax
  \expandafter\ifx\csname T@T2A\endcsname\relax
  \else
  % T2A was declared as font encoding
    \substitutefont{T2A}{\rmdefault}{cmr}
    \substitutefont{T2A}{\sfdefault}{cmss}
    \substitutefont{T2A}{\ttdefault}{cmtt}
  \fi
\else
% X2 was declared as font encoding
  \substitutefont{X2}{\rmdefault}{cmr}
  \substitutefont{X2}{\sfdefault}{cmss}
  \substitutefont{X2}{\ttdefault}{cmtt}
\fi
<% endif %>

\usepackage[Bjarne]{fncychap}
\usepackage{sphinx}
<% if sphinx_version >= (4, 0) %>
\fvset{fontsize=auto}
<% else %>
\fvset{fontsize=\small}
<% endif -%>
\usepackage{geometry}


% Include hyperref last.
\usepackage{hyperref}
% Fix anchor placement for figures with captions.
\usepackage{hypcap}% it must be loaded after hyperref.
% Set up styles of URL: it should be placed after hyperref.
\urlstyle{same}


\usepackage{sphinxmessages}
\setcounter{tocdepth}{1}



\definecolor{nbsphinxin}{HTML}{307FC1}
\definecolor{nbsphinxout}{HTML}{BF5B3D}
\newcommand\thesymbolfootnote{\fnsymbol{footnote}}\let\thenumberfootnote\thefootnote

\definecolor{regex_literal}{HTML}{696969}
\definecolor{regex_at}{HTML}{FF4500}
\definecolor{regex_repeat_brace}{HTML}{FF4500}
\definecolor{regex_branch}{HTML}{FF4500}
\definecolor{regex_subpattern}{HTML}{1e90ff}
\definecolor{regex_in}{HTML}{ff8c00}
\definecolor{regex_category}{HTML}{8fbc8f}
\definecolor{regex_repeat}{HTML}{FF4500}
\definecolor{regex_any}{HTML}{FF4500}
\usepackage[]{bookmark}
\newcommand{\thesummary}{This is an awesome tool! 🚀 \textasciitilde\space intersphinx\_mapping \#  100\% ‘Quotes’}

\makeatletter
\renewcommand{\py@release}{
	\releasename\space\version
	\par
	\vspace{25pt}
	\textup{\thesummary}
}
\makeatother


\title{Python}
\date{Mar 11, 2021}
\release{}
\author{unknown}
\newcommand{\sphinxlogo}{\vbox{}}
\renewcommand{\releasename}{}
\makeindex
\begin{document}

<% if sphinx_version >= (5, 0) %>\ifdefined\shorthandoff
  \ifnum\catcode`\=\string=\active\shorthandoff{=}\fi
  \ifnum\catcode`\"=\active\shorthandoff{"}\fi
\fi

<% endif %>\pagestyle{empty}
\sphinxmaketitle
\makeatletter\renewcommand{\py@release}{\releasename\space\version}\makeatother
\pagestyle{plain}
\sphinxtableofcontents
\pagestyle{normal}
\phantomsection\label{\detokenize{index::doc}}
\part{Documentation}

<% if sphinx_version > (4, 5) -%>
\sphinxstepscope

<% endif %>


\chapter{from PyPI}
\label{\detokenize{installation:installation-0-from_PyPI}}\label{\detokenize{installation:installation-0}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my_project --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-1-from_PyPI}}\label{\detokenize{installation:installation-1}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-2-from_PyPI}}\label{\detokenize{installation:installation-2}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-3-from_Anaconda}}\label{\detokenize{installation:installation-3}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my_project
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-4-from_Anaconda}}\label{\detokenize{installation:installation-4}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-5-from_Anaconda}}\label{\detokenize{installation:installation-5}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-6-from_GitHub}}\label{\detokenize{installation:installation-6}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-7-from_GitHub}}\label{\detokenize{installation:installation-7}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-8-from_PyPI}}\label{\detokenize{installation:installation-8}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my_project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-8-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my_project
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-9-from_PyPI}}\label{\detokenize{installation:installation-9}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-9-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-10-from_PyPI}}\label{\detokenize{installation:installation-10}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-10-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-11-from_PyPI}}\label{\detokenize{installation:installation-11}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-11-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install conda-project
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-12-from_PyPI}}\label{\detokenize{installation:installation-12}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-12-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install conda-project
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-13-from_PyPI}}\label{\detokenize{installation:installation-13}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my_project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-13-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my_project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-13-from_GitHub}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-14-from_PyPI}}\label{\detokenize{installation:installation-14}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-14-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-14-from_GitHub}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-15-from_PyPI}}\label{\detokenize{installation:installation-15}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-15-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install my-project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-15-from_GitHub}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-16-from_PyPI}}\label{\detokenize{installation:installation-16}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-16-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install conda-project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-16-from_GitHub}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}


\chapter{from PyPI}
\label{\detokenize{installation:installation-17-from_PyPI}}\label{\detokenize{installation:installation-17}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install my-project --user
\end{Verbatim}


\chapter{from Anaconda}
\label{\detokenize{installation:installation-17-from_Anaconda}}
\begin{Verbatim}[commandchars=\\\{\}]
$ conda install conda-project
\end{Verbatim}


\chapter{from GitHub}
\label{\detokenize{installation:installation-17-from_GitHub}}
\begin{Verbatim}[commandchars=\\\{\}]
$ python3 -m pip install git+https://github.com/sphinx-toolbox/sphinx-toolbox@master --user
\end{Verbatim}

\phantomsection\label{\detokenize{installation:extensions-0}}

\vspace{10px}

Enable \sphinxcode{\sphinxupquote{my\sphinxhyphen{}extension}} by adding the following
to the \sphinxcode{\sphinxupquote{extensions}} variable in your \sphinxcode{\sphinxupquote{conf.py}}:

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{foo}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{bar}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{baz}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZhy{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}
\begin{flushleft}
For more information see \sphinxurl{https://www.sphinx-doc.org/en/master/usage/extensions\#third-party-extensions} .
\end{flushleft}

\phantomsection\label{\detokenize{installation:extensions-1}}

\vspace{10px}

Enable \sphinxcode{\sphinxupquote{my\sphinxhyphen{}extension}} by adding the following
to the \sphinxcode{\sphinxupquote{extensions}} variable in your \sphinxcode{\sphinxupquote{conf.py}}:

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{foo}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{bar}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{baz}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZus{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}
\begin{flushleft}
For more information see \sphinxurl{https://www.sphinx-doc.org/en/master/usage/extensions\#third-party-extensions} .
\end{flushleft}

\phantomsection\label{\detokenize{installation:extensions-2}}

\vspace{10px}

Enable \sphinxcode{\sphinxupquote{my\sphinxhyphen{}extension}} by adding the following
to the \sphinxcode{\sphinxupquote{extensions}} variable in your \sphinxcode{\sphinxupquote{conf.py}}:

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZus{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}
\begin{flushleft}
For more information see \sphinxurl{https://www.sphinx-doc.org/en/master/usage/extensions\#third-party-extensions} .
\end{flushleft}

\phantomsection\label{\detokenize{installation:extensions-3}}

\vspace{10px}

Enable \sphinxcode{\sphinxupquote{my\sphinxhyphen{}extension}} by adding the following
to the \sphinxcode{\sphinxupquote{extensions}} variable in your \sphinxcode{\sphinxupquote{conf.py}}:

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZhy{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}
\begin{flushleft}
For more information see \sphinxurl{https://www.sphinx-doc.org/en/master/usage/extensions\#third-party-extensions} .
\end{flushleft}

\phantomsection\label{\detokenize{installation:extensions-4}}

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZhy{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}
\begin{flushleft}
For more information see \sphinxurl{https://www.sphinx-doc.org/en/master/usage/extensions\#third-party-extensions} .
\end{flushleft}

\phantomsection\label{\detokenize{installation:extensions-5}}

\vspace{10px}

Enable \sphinxcode{\sphinxupquote{my\sphinxhyphen{}extension}} by adding the following
to the \sphinxcode{\sphinxupquote{extensions}} variable in your \sphinxcode{\sphinxupquote{conf.py}}:

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{extensions} \PYG{o}{=} \PYG{p}{[}
    \PYG{o}{.}\PYG{o}{.}\PYG{o}{.}
    \PYG{l+s+s1}{\PYGZsq{}}\PYG{l+s+s1}{my\PYGZhy{}extension}\PYG{l+s+s1}{\PYGZsq{}}\PYG{p}{,}
    \PYG{p}{]}
\end{sphinxVerbatim}

<% if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{Collapse}
\label{\detokenize{collapse:collapse}}\label{\detokenize{collapse::doc}}
Something small enough to escape casual notice.

Something else that might escape notice.

The text should be visible when the page loads.
<% if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{Confval}
\label{\detokenize{confval:confval}}\label{\detokenize{confval::doc}}\index{source\_link\_target (configuration value)@\spxentry{source\_link\_target}\spxextra{configuration value}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{confval:confval-source_link_target}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{source\_link\_target}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-45px}

\begin{DUlineblock}{0em}
\item[] \sphinxstylestrong{Type:} \sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}
\item[] \sphinxstylestrong{Required:} \sphinxcode{\sphinxupquote{False}}
\item[] \sphinxstylestrong{Default:} \sphinxcode{\sphinxupquote{\textquotesingle{}Sphinx\textquotesingle{}}}
\end{DUlineblock}

\vspace{-25px}

The target of the source link, either \sphinxcode{\sphinxupquote{\textquotesingle{}GitHub\textquotesingle{}}} or \sphinxcode{\sphinxupquote{\textquotesingle{}Sphinx\textquotesingle{}}}.
Case insensitive.

\end{fulllineitems}

\index{github\_username (configuration value)@\spxentry{github\_username}\spxextra{configuration value}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{confval:confval-github_username}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{github\_username}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-45px}

\begin{DUlineblock}{0em}
\item[] \sphinxstylestrong{Type:} \sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}
\item[] \sphinxstylestrong{Required:} \sphinxcode{\sphinxupquote{True}}
\end{DUlineblock}

\end{fulllineitems}

\index{github\_repository (configuration value)@\spxentry{github\_repository}\spxextra{configuration value}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{confval:confval-github_repository}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{github\_repository}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-45px}

\begin{DUlineblock}{0em}
\item[] \sphinxstylestrong{Type:} \sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}
\item[] \sphinxstylestrong{Required:} \sphinxcode{\sphinxupquote{True}}
\end{DUlineblock}

\vspace{-25px}

The GitHub repository this documentation corresponds to.

\end{fulllineitems}

\index{conda\_channels (configuration value)@\spxentry{conda\_channels}\spxextra{configuration value}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{confval:confval-conda_channels}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{conda\_channels}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-45px}

\begin{DUlineblock}{0em}
\item[] \sphinxstylestrong{Type:} Comma\sphinxhyphen{}separated list of strings
\item[] \sphinxstylestrong{Required:} \sphinxcode{\sphinxupquote{True}}
\end{DUlineblock}

\vspace{-25px}

The conda channels required to install the library from Anaconda.

\end{fulllineitems}



\begin{fulllineitems}
<% if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{github\_repository}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-45px}

\begin{DUlineblock}{0em}
\item[] \sphinxstylestrong{Type:} \sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}
\end{DUlineblock}

\vspace{-25px}

This is a duplicate with \sphinxcode{\sphinxupquote{:noindex:}} set.

\end{fulllineitems}


This is an xref to the {\hyperref[\detokenize{confval:confval-github_repository}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{github\_repository}}}}} configuration option.
\index{something (configuration value)@\spxentry{something}\spxextra{configuration value}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{confval:confval-something}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{something}}}<< tilde >>
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\vspace{-25px}

A configuration value.

\end{fulllineitems}

<% if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} Code}
\label{\detokenize{code-block:sphinx-toolbox-demo-code}}\label{\detokenize{code-block::doc}}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
        \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}

\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}

\begin{sphinxVerbatim}[commandchars=\\\{\},numbers=left,firstnumber=1,stepnumber=1]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}


\section{Code Cell}
\label{\detokenize{code-block:code-cell}}
<%- if sphinx_version >= (4, 1) %>
\begin{sphinxuseclass}{code-cell}<% endif %>

\vspace{4mm}\llap{\color{nbsphinxin}\texttt{In [1]:}\,\hspace{\fboxrule}\hspace{\fboxrule}\hspace{\fboxsep}}\vspace{-7mm}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
    \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}

\PYG{n+nb}{print}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{hello world}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
\end{sphinxVerbatim}
<% if sphinx_version >= (4, 1) %>
\end{sphinxuseclass}
\begin{sphinxuseclass}{output-cell}<% endif %>

\vspace{4mm}\llap{\color{nbsphinxout}\texttt{[1]:}\,\hspace{\fboxrule}\hspace{\fboxrule}\hspace{\fboxsep}}\vspace{-7mm}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n}{hello} \PYG{n}{world}
\end{sphinxVerbatim}
<% if sphinx_version >= (4, 1) %>
\end{sphinxuseclass}
\begin{sphinxuseclass}{code-cell}<% endif %>

\vspace{4mm}\llap{\color{nbsphinxin}\texttt{In [2]:}\,\hspace{\fboxrule}\hspace{\fboxrule}\hspace{\fboxsep}}\vspace{-7mm}
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{k}{def} \PYG{n+nf}{print}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}\PYG{p}{:}
        \PYG{n}{sys}\PYG{o}{.}\PYG{n}{stdout}\PYG{o}{.}\PYG{n}{write}\PYG{p}{(}\PYG{n}{text}\PYG{p}{)}
\end{sphinxVerbatim}
<% if sphinx_version >= (4, 1) %>
\end{sphinxuseclass}<% endif %>
<%- if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} Formatting}
\label{\detokenize{formatting:sphinx-toolbox-demo-formatting}}\label{\detokenize{formatting::doc}}
\textit{\sphinxstyleabbreviation{m/z} (mass to charge ratio)}

\textit{\sphinxstyleabbreviation{doodad}}

\vspace{10px}\sphinxstylestrong{Examples:}

\vspace{10px}\sphinxstylestrong{Other Extensions}
<%- if sphinx_version > (4, 5) %>

\sphinxstepscope<% endif %>


\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} footnotes}
\label{\detokenize{footnote_symbols:sphinx-toolbox-demo-footnotes}}\label{\detokenize{footnote_symbols::doc}}
Some text %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[2]\sphinxAtStartFootnote
An auto\sphinxhyphen{}symbol footnote
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}

Some more text %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[3]\sphinxAtStartFootnote
Another footnote
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}

Sometimes %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[4]\sphinxAtStartFootnote
A footnote with lots of content.

\sphinxSetupCodeBlockInFootnote
\begin{sphinxVerbatim}[commandchars=\\\{\}]
\PYG{n+nb}{print}\PYG{p}{(}\PYG{l+s+s2}{\PYGZdq{}}\PYG{l+s+s2}{Look ma! I}\PYG{l+s+s2}{\PYGZsq{}}\PYG{l+s+s2}{m in a footnote}\PYG{l+s+s2}{\PYGZdq{}}\PYG{p}{)}
\end{sphinxVerbatim}
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote} strange things happen.
<%- if sphinx_version > (4, 5) %>

\sphinxstepscope<% endif %>


\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} LaTeX}
\label{\detokenize{latex:sphinx-toolbox-demo-latex}}\label{\detokenize{latex::doc}}
\clearpage

\par\begin{samepage}

Content under the samepage directive

\begin{figure}[htbp]
\centering

\noindent\sphinxincludegraphics{{75883961}.png}
\end{figure}

\end{samepage}\par

\cleardoublepage

The \hspace{0pt}following \hspace{0pt}characters \hspace{0pt}are \hspace{0pt}problematic \hspace{0pt}in \hspace{0pt}LaTeX:
\begin{itemize}
\item {}
 $\spadesuit$

\item {}
 $\heartsuit$

\item {}
 $\diamondsuit$

\item {}
 $\clubsuit$

\item {}
\textmu{}

\item {}
 $\equiv$

\end{itemize}

\clearpage

Hello

\clearpage

\par\begin{samepage}

Content under the samepage directive

\begin{figure}[htbp]
\centering

\noindent\sphinxincludegraphics{{75883961}.png}
\end{figure}

\end{samepage}\par


\vspace{-5px}


\cleardoublepage

The \hspace{0pt}following \hspace{0pt}characters \hspace{0pt}are \hspace{0pt}problematic \hspace{0pt}in \hspace{0pt}LaTeX:
\begin{itemize}
\item {}
 $\spadesuit$

\item {}
 $\heartsuit$

\item {}
 $\diamondsuit$

\item {}
 $\clubsuit$

\item {}
\textmu{}

\item {}
 $\equiv$

\item {}
 $\approx$

\end{itemize}

This is a \textmu{}\sphinxhyphen{}library for doing something.

The Greek letter \textmu{} has several uses.


\vspace{10px}


\clearpage


\vspace{30mm}


Goodbyeee!


\section{Example Footnotes}
\label{\detokenize{latex:example-footnotes}}
\begin{DUlineblock}{0em}
\item[] Hello %
\begin{footnote}[1]\sphinxAtStartFootnote
One
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Goodbye %
\begin{footnote}[2]\sphinxAtStartFootnote
Two
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[2]\sphinxAtStartFootnote
Buckle my shoe
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Another Symbol %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[3]\sphinxAtStartFootnote
The second symbol
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Number Again %
\begin{footnote}[3]\sphinxAtStartFootnote
The number after the symbol
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 3 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[4]\sphinxAtStartFootnote
Symbol 3
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 4 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[5]\sphinxAtStartFootnote
Symbol 4
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 5 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[6]\sphinxAtStartFootnote
Symbol 5
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 6 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[7]\sphinxAtStartFootnote
Symbol 6
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 7 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[8]\sphinxAtStartFootnote
Symbol 7
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 8 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[9]\sphinxAtStartFootnote
Symbol 8
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\item[] Symbol 9 %
\renewcommand\thefootnote{\thesymbolfootnote}\begin{footnote}[10]\sphinxAtStartFootnote
Symbol 9
%
\end{footnote}\renewcommand\thefootnote{\thenumberfootnote}
\end{DUlineblock}


\vspace{20px}



\sphinxstrong{See also:}
Check this out on GitHub




<% if sphinx_version >= (6, 2) %>\begin{sphinxseealso}{See also:}<% elif sphinx_version >= (6, 1) %>\begin{sphinxseealso}{See also}<% else %>\sphinxstrong{See also:}
<% if sphinx_version >= (3, 4) %>\nopagebreak
<% endif %><% endif %>

These are helpful resources:
\begin{itemize}
\item {}
Google

\item {}
StackOverflow

\item {}
RealPython

\end{itemize}

<% if sphinx_version >= (6, 1) %>
\end{sphinxseealso}
<% endif %><% if sphinx_version > (4, 5) %>

\sphinxstepscope<% endif %>


\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} Regex}
\label{\detokenize{regex:module-sphinx_toolbox.utils}}\label{\detokenize{regex:sphinx-toolbox-demo-regex}}\label{\detokenize{regex::doc}}\index{module@\spxentry{module}!sphinx\_toolbox.utils@\spxentry{sphinx\_toolbox.utils}}\index{sphinx\_toolbox.utils@\spxentry{sphinx\_toolbox.utils}!module@\spxentry{module}}
General utility functions.
\index{untyped\_param\_regex (in module sphinx\_toolbox.utils)@\spxentry{untyped\_param\_regex}\spxextra{in module sphinx\_toolbox.utils}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:sphinx_toolbox.utils.untyped_param_regex}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{sphinx\_toolbox.utils.}}\sphinxbfcode{\sphinxupquote{untyped\_param\_regex}}}
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}{[}\sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}{]}

Regex to match \sphinxcode{\sphinxupquote{:param \textless{}name\textgreater{}: \textless{}docstring\textgreater{}}} flags.

<< versionadded("0.8.0") >>


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_at}{\textasciicircum{}}\textcolor{regex_literal}{:}\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{p}\textcolor{regex_literal}{a}\textcolor{regex_literal}{r}\textcolor{regex_literal}{a}\textcolor{regex_literal}{m}\textcolor{regex_branch}{|}\textcolor{regex_literal}{p}\textcolor{regex_literal}{a}\textcolor{regex_literal}{r}\textcolor{regex_literal}{a}\textcolor{regex_literal}{m}\textcolor{regex_literal}{e}\textcolor{regex_literal}{t}\textcolor{regex_literal}{e}\textcolor{regex_literal}{r}\textcolor{regex_branch}{|}\textcolor{regex_literal}{a}\textcolor{regex_literal}{r}\textcolor{regex_literal}{g}\textcolor{regex_branch}{|}\textcolor{regex_literal}{a}\textcolor{regex_literal}{r}\textcolor{regex_literal}{g}\textcolor{regex_literal}{u}\textcolor{regex_literal}{m}\textcolor{regex_literal}{e}\textcolor{regex_literal}{n}\textcolor{regex_literal}{t}\textcolor{regex_subpattern}{)}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_category}{\textbackslash{}w}\textcolor{regex_repeat}{*}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{:}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}}}
\\
<< hline >>\sphinxstyletheadfamily
\sphinxstylestrong{Flags}
&
\sphinxhref{https://docs.python.org/3/library/re.html\#re.ASCII}{\sphinxcode{\sphinxupquote{re.ASCII}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{typed\_flag\_regex (in module sphinx\_toolbox.utils)@\spxentry{typed\_flag\_regex}\spxextra{in module sphinx\_toolbox.utils}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:sphinx_toolbox.utils.typed_flag_regex}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{sphinx\_toolbox.utils.}}\sphinxbfcode{\sphinxupquote{typed\_flag\_regex}}}
<% if sphinx_version > (4, 5) %>\pysigstopsignatures
<% endif -%>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}{[}\sphinxhref{https://docs.python.org/3/library/stdtypes.html\#str}{\sphinxcode{\sphinxupquote{str}}}{]}

Regex to match \sphinxcode{\sphinxupquote{:type \textless{}name\textgreater{}: \textless{}type\textgreater{}}} flags.

<< versionadded("0.8.0") >>


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_at}{\textasciicircum{}}\textcolor{regex_literal}{:}\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{p}\textcolor{regex_literal}{a}\textcolor{regex_literal}{r}\textcolor{regex_literal}{a}\textcolor{regex_literal}{m}\textcolor{regex_literal}{t}\textcolor{regex_literal}{y}\textcolor{regex_literal}{p}\textcolor{regex_literal}{e}\textcolor{regex_branch}{|}\textcolor{regex_literal}{t}\textcolor{regex_literal}{y}\textcolor{regex_literal}{p}\textcolor{regex_literal}{e}\textcolor{regex_subpattern}{)}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_category}{\textbackslash{}w}\textcolor{regex_repeat}{*}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{:}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}}}
\\
<< hline >>\sphinxstyletheadfamily
\sphinxstylestrong{Flags}
&
\sphinxhref{https://docs.python.org/3/library/re.html\#re.ASCII}{\sphinxcode{\sphinxupquote{re.ASCII}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}


\sphinxcode{\sphinxupquote{\textcolor{regex_at}{\textasciicircum{}}\textcolor{regex_literal}{H}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{l}\textcolor{regex_literal}{o}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{+}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{W}\textcolor{regex_literal}{w}\textcolor{regex_in}{{]}}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{l}\textcolor{regex_literal}{d}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{.}\textcolor{regex_literal}{,}\textcolor{regex_in}{{]}}\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{L}\textcolor{regex_literal}{o}\textcolor{regex_literal}{v}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{y}\textcolor{regex_branch}{|}\textcolor{regex_literal}{H}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{r}\textcolor{regex_literal}{i}\textcolor{regex_literal}{b}\textcolor{regex_literal}{l}\textcolor{regex_literal}{e}\textcolor{regex_subpattern}{)}\enspace\textcolor{regex_literal}{w}\textcolor{regex_literal}{e}\textcolor{regex_literal}{a}\textcolor{regex_literal}{t}\textcolor{regex_literal}{h}\textcolor{regex_literal}{e}\textcolor{regex_literal}{r}\textcolor{regex_literal}{,}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{s}\textcolor{regex_literal}{n}\textcolor{regex_literal}{\textquotesingle{}}\textcolor{regex_literal}{t}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{t}\enspace\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{?}}}
\index{no\_flags (in module tests.regex\_demo)@\spxentry{no\_flags}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.no_flags}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{no\_flags}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_literal}{H}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{l}\textcolor{regex_literal}{o}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{+}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{W}\textcolor{regex_literal}{w}\textcolor{regex_in}{{]}}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{l}\textcolor{regex_literal}{d}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{.}\textcolor{regex_literal}{,}\textcolor{regex_in}{{]}}\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{L}\textcolor{regex_literal}{o}\textcolor{regex_literal}{v}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{y}\textcolor{regex_branch}{|}\textcolor{regex_literal}{H}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{r}\textcolor{regex_literal}{i}\textcolor{regex_literal}{b}\textcolor{regex_literal}{l}\textcolor{regex_literal}{e}\textcolor{regex_subpattern}{)}\enspace\textcolor{regex_literal}{w}\textcolor{regex_literal}{e}\textcolor{regex_literal}{a}\textcolor{regex_literal}{t}\textcolor{regex_literal}{h}\textcolor{regex_literal}{e}\textcolor{regex_literal}{r}\textcolor{regex_literal}{,}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{s}\textcolor{regex_literal}{n}\textcolor{regex_literal}{\textquotesingle{}}\textcolor{regex_literal}{t}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{t}\enspace\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{?}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{one\_flag (in module tests.regex\_demo)@\spxentry{one\_flag}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.one_flag}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{one\_flag}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_literal}{H}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{l}\textcolor{regex_literal}{o}\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{+}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{W}\textcolor{regex_literal}{w}\textcolor{regex_in}{{]}}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{l}\textcolor{regex_literal}{d}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{.}\textcolor{regex_literal}{,}\textcolor{regex_in}{{]}}\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{L}\textcolor{regex_literal}{o}\textcolor{regex_literal}{v}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{y}\textcolor{regex_branch}{|}\textcolor{regex_literal}{H}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{r}\textcolor{regex_literal}{i}\textcolor{regex_literal}{b}\textcolor{regex_literal}{l}\textcolor{regex_literal}{e}\textcolor{regex_subpattern}{)}\enspace\textcolor{regex_literal}{w}\textcolor{regex_literal}{e}\textcolor{regex_literal}{a}\textcolor{regex_literal}{t}\textcolor{regex_literal}{h}\textcolor{regex_literal}{e}\textcolor{regex_literal}{r}\textcolor{regex_literal}{,}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{s}\textcolor{regex_literal}{n}\textcolor{regex_literal}{\textquotesingle{}}\textcolor{regex_literal}{t}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{t}\enspace\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{?}}}
\\<% if sphinx_version >= (5, 3) %>
\sphinxhline\sphinxstyletheadfamily<% else %>
\hline\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Flags}
&
\sphinxhref{https://docs.python.org/3/library/re.html\#re.IGNORECASE}{\sphinxcode{\sphinxupquote{re.IGNORECASE}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{two\_flags (in module tests.regex\_demo)@\spxentry{two\_flags}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.two_flags}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{two\_flags}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_literal}{H}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{l}\textcolor{regex_literal}{o}\enspace\textcolor{regex_category}{\textbackslash{}s}\textcolor{regex_repeat}{+}\enspace\textcolor{regex_in}{{[}}\textcolor{regex_literal}{W}\textcolor{regex_literal}{w}\textcolor{regex_in}{{]}}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{l}\textcolor{regex_literal}{d}\enspace\textcolor{regex_in}{{[}}\textcolor{regex_literal}{.}\textcolor{regex_literal}{,}\textcolor{regex_in}{{]}}\enspace\textcolor{regex_subpattern}{(}\textcolor{regex_literal}{L}\textcolor{regex_literal}{o}\textcolor{regex_literal}{v}\textcolor{regex_literal}{e}\textcolor{regex_literal}{l}\textcolor{regex_literal}{y}\textcolor{regex_branch}{|}\textcolor{regex_literal}{H}\textcolor{regex_literal}{o}\textcolor{regex_literal}{r}\textcolor{regex_literal}{r}\textcolor{regex_literal}{i}\textcolor{regex_literal}{b}\textcolor{regex_literal}{l}\textcolor{regex_literal}{e}\textcolor{regex_subpattern}{)}\enspace\textcolor{regex_literal}{w}\textcolor{regex_literal}{e}\textcolor{regex_literal}{a}\textcolor{regex_literal}{t}\textcolor{regex_literal}{h}\textcolor{regex_literal}{e}\textcolor{regex_literal}{r}\textcolor{regex_literal}{,}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{s}\textcolor{regex_literal}{n}\textcolor{regex_literal}{\textquotesingle{}}\textcolor{regex_literal}{t}\enspace\textcolor{regex_literal}{i}\textcolor{regex_literal}{t}\enspace\textcolor{regex_subpattern}{(}\textcolor{regex_any}{.}\textcolor{regex_repeat}{*}\textcolor{regex_subpattern}{)}\enspace\textcolor{regex_literal}{?}}}
\\
<< hline >>\sphinxstyletheadfamily
\sphinxstylestrong{Flags}
&
\sphinxhref{https://docs.python.org/3/library/re.html\#re.ASCII}{\sphinxcode{\sphinxupquote{re.ASCII}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{backticks (in module tests.regex\_demo)@\spxentry{backticks}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.backticks}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{backticks}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_literal}{:}\textcolor{regex_literal}{p}\textcolor{regex_literal}{y}\textcolor{regex_literal}{:}\textcolor{regex_literal}{c}\textcolor{regex_literal}{l}\textcolor{regex_literal}{a}\textcolor{regex_literal}{s}\textcolor{regex_literal}{s}\textcolor{regex_literal}{:}\textcolor{regex_literal}{\textasciigrave{}}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{0}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{9}\textcolor{regex_literal}{.}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_repeat}{+}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{\textasciigrave{}}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{leading\_whitespace (in module tests.regex\_demo)@\spxentry{leading\_whitespace}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.leading_whitespace}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{leading\_whitespace}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_in}{{[}}\enspace\textcolor{regex_in}{{]}}\textcolor{regex_literal}{3}\textcolor{regex_literal}{:}\textcolor{regex_literal}{p}\textcolor{regex_literal}{y}\textcolor{regex_literal}{:}\textcolor{regex_literal}{c}\textcolor{regex_literal}{l}\textcolor{regex_literal}{a}\textcolor{regex_literal}{s}\textcolor{regex_literal}{s}\textcolor{regex_literal}{:}\textcolor{regex_literal}{\textasciigrave{}}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{0}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{9}\textcolor{regex_literal}{.}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_repeat}{+}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{\textasciigrave{}}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{trailing\_whitespace (in module tests.regex\_demo)@\spxentry{trailing\_whitespace}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.trailing_whitespace}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{trailing\_whitespace}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_literal}{:}\textcolor{regex_literal}{p}\textcolor{regex_literal}{y}\textcolor{regex_literal}{:}\textcolor{regex_literal}{c}\textcolor{regex_literal}{l}\textcolor{regex_literal}{a}\textcolor{regex_literal}{s}\textcolor{regex_literal}{s}\textcolor{regex_literal}{:}\textcolor{regex_literal}{\textasciigrave{}}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{0}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{9}\textcolor{regex_literal}{.}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_repeat}{+}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{\textasciigrave{}}\enspace\textcolor{regex_literal}{3}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

\index{single\_whitespace (in module tests.regex\_demo)@\spxentry{single\_whitespace}\spxextra{in module tests.regex\_demo}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{regex:tests.regex_demo.single_whitespace}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysigline<< sphinx81_linebreak >>{\sphinxcode{\sphinxupquote{tests.regex\_demo.}}\sphinxbfcode{\sphinxupquote{single\_whitespace}}}
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif %>
\sphinxstylestrong{Type:}    \sphinxhref{https://docs.python.org/3/library/typing.html\#typing.Pattern}{\sphinxcode{\sphinxupquote{Pattern}}}

Compiled regular expression object.


\begin{savenotes}\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{<<regex_columns>>}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook\sphinxstyletheadfamily<% else %>
\hline
\sphinxstyletheadfamily<% endif %>
\sphinxstylestrong{Pattern}
&
\sphinxcode{\sphinxupquote{\textcolor{regex_in}{{[}}\enspace\textcolor{regex_in}{{]}}\textcolor{regex_literal}{:}\textcolor{regex_literal}{p}\textcolor{regex_literal}{y}\textcolor{regex_literal}{:}\textcolor{regex_literal}{c}\textcolor{regex_literal}{l}\textcolor{regex_literal}{a}\textcolor{regex_literal}{s}\textcolor{regex_literal}{s}\textcolor{regex_literal}{:}\textcolor{regex_literal}{\textasciigrave{}}\textcolor{regex_subpattern}{(}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_in}{{[}}\textcolor{regex_literal}{A}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{Z}\textcolor{regex_literal}{a}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{z}\textcolor{regex_literal}{0}\textcolor{regex_at}{\sphinxhyphen{}}\textcolor{regex_literal}{9}\textcolor{regex_literal}{.}\textcolor{regex_literal}{\_}\textcolor{regex_in}{{]}}\textcolor{regex_repeat}{+}\textcolor{regex_subpattern}{)}\textcolor{regex_literal}{\textasciigrave{}}\textcolor{regex_in}{{[}}\enspace\textcolor{regex_in}{{]}}}}
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}

\end{fulllineitems}

<% if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{sphinx\sphinxhyphen{}toolbox Demo \sphinxhyphen{} GitHub}
\label{\detokenize{github:sphinx-toolbox-demo-github}}\label{\detokenize{github::doc}}

\section{Issues}
\label{\detokenize{github:issues}}
\sphinxhref{https://github.com/sphinx-toolbox/sphinx-toolbox/issues/1}{\#1}

\sphinxhref{https://github.com/pytest-dev/pytest/issues/7680}{pytest\sphinxhyphen{}dev/pytest\#7680}


\section{Pull Requests}
\label{\detokenize{github:pull-requests}}
\sphinxhref{https://github.com/sphinx-toolbox/sphinx-toolbox/pull/2}{\#2}

\sphinxhref{https://github.com/pytest-dev/pytest/pull/7671}{pytest\sphinxhyphen{}dev/pytest\#7671}


\section{Repositories}
\label{\detokenize{github:repositories}}
\sphinxhref{https://github.com/sphinx-toolbox/sphinx-toolbox}{sphinx\sphinxhyphen{}toolbox/sphinx\sphinxhyphen{}toolbox}

See more in the \sphinxhref{https://github.com/pytest-dev/pytest}{pytest repository}.


\section{Users}
\label{\detokenize{github:users}}
\sphinxhref{https://github.com/domdfcoding}{@domdfcoding}

See more of my \sphinxhref{https://github.com/domdfcoding}{repositories}.


\section{Orgs}
\label{\detokenize{github:orgs}}
\sphinxhref{https://github.com/sphinx-toolbox}{@sphinx\sphinxhyphen{}toolbox}

See more repositories in the \sphinxhref{https://github.com/pytest-dev}{pytest\sphinxhyphen{}dev org}.
<% if sphinx_version > (4, 5) %>
\sphinxstepscope
<% endif %>

\chapter{Changeset}
\label{\detokenize{changeset:changeset}}\label{\detokenize{changeset::doc}}

\section{Removed}
\label{\detokenize{changeset:removed}}
<< versionremoved("1.2.3")>>Use {\hyperref[\detokenize{index:foo}]{\sphinxcrossref{\sphinxcode{\sphinxupquote{foo()}}}}} instead.

<< versionremoved("1.2.3")>>Due to an unfixable bug this function has been removed.
If you desperately need this functionality please write to the mailing list at
\sphinxhref{mailto:python-users@example.org}{python\sphinxhyphen{}users@example.org}


<< versionremoved("1.2.3")>>\begin{itemize}
\item {}
Removed \sphinxcode{\sphinxupquote{mozarella}}

\item {}
Removed \sphinxcode{\sphinxupquote{parrot()}} from \sphinxcode{\sphinxupquote{pet\_shop}}

\end{itemize}


\section{Changed}
\label{\detokenize{changeset:changed}}
<< versionchanged("1.2.3") >>Moved from \sphinxcode{\sphinxupquote{mozarella}}


<< versionchanged("0.3.0") >>\begin{itemize}
\item {}
Parameters for \sphinxcode{\sphinxupquote{\_\_init\_\_}} can be documented either in the class docstring
or alongside the attribute.
The class docstring has priority.

\item {}
Added support for \sphinxhref{https://github.com/Chilipp/autodocsumm}{autodocsumm}.

\end{itemize}
\index{built\sphinxhyphen{}in function@\spxentry{built\sphinxhyphen{}in function}!foo()@\spxentry{foo()}}\index{foo()@\spxentry{foo()}!built\sphinxhyphen{}in function@\spxentry{built\sphinxhyphen{}in function}}

\begin{fulllineitems}
\phantomsection\label{\detokenize{index:foo}}
<%- if sphinx_version > (4, 5) %>
\pysigstartsignatures
<% endif -%>
\pysiglinewithargsret<< sphinx81_linebreak >>{\sphinxbfcode{\sphinxupquote{foo}}}<< sphinx81_linebreak >>{\<<sphinxparam>>{\DUrole{n<< du_role_2nd_n >>}{bar}}<<sphinxparamcomma>>{\DUrole{n<< du_role_2nd_n >>}{baz}}}<< sphinx81_linebreak >>{}<< tilde >>
<%- if sphinx_version > (4, 5) %>
\pysigstopsignatures
<%- endif -%>
\begin{quote}\begin{description}
<% if sphinx_version >= (5, 0) %>\sphinxlineitem{Parameters}<% else %>\item[{Parameters}] \leavevmode<% endif %>\begin{itemize}
\item {}
\sphinxstyleliteralstrong{\sphinxupquote{bar}} \textendash{} Does something

\item {}
\sphinxstyleliteralstrong{\sphinxupquote{baz}} \textendash{} Does something else

\end{itemize}

\end{description}\end{quote}

\end{fulllineitems}



\vspace{10px}


\sphinxstylestrong{Classes:}


\vspace{-5px}



\begin{savenotes}<%- if sphinx_version > (8, 2) %>
\sphinxatlongtablestart
\sphinxthistablewithglobalstyle
\sphinxthistablewithnovlinesstyle
\makeatletter
  \LTleft \@totalleftmargin plus1fill
  \LTright\dimexpr\columnwidth-\@totalleftmargin-\linewidth\relax plus1fill
\makeatother
\begin{longtable}{\X{1}{2}\X{1}{2}}
\sphinxtoprule
\endfirsthead

\multicolumn{2}{c}{\sphinxnorowcolor
    \makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}%
}\\
\sphinxtoprule
\endhead

\sphinxbottomrule
\multicolumn{2}{r}{\sphinxnorowcolor
    \makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}%
}\\
\endfoot

\endlastfoot
\sphinxtableatstartofbodyhook
<% elif sphinx_version > (4, 5) -%>
\sphinxattablestart<% if sphinx_version >= (5, 3) %>
\sphinxthistablewithglobalstyle
\sphinxthistablewithnovlinesstyle<% endif %>
\centering
\begin{tabulary}{\linewidth}[t]{\X{1}{2}\X{1}{2}}<% if sphinx_version >= (5, 3) %>
\sphinxtoprule
\sphinxtableatstartofbodyhook<% else %>
\hline

<%- endif %><% else %>\sphinxatlongtablestart\begin{longtable}[c]{\X{1}{2}\X{1}{2}}
\hline

\endfirsthead

\multicolumn{2}{c}%
{\makebox[0pt]{\sphinxtablecontinued{\tablename\ \thetable{} \textendash{} continued from previous page}}}\\
\hline

\endhead

\hline
\multicolumn{2}{r}{\makebox[0pt][r]{\sphinxtablecontinued{continues on next page}}}\\
\endfoot

\endlastfoot
<%- endif %>
<% if sphinx_version < (5, 3) %>
<% endif %>\sphinxcode{\sphinxupquote{Animal}}(name, voice)
&
An animal.
\\
<< hline >>
\sphinxcode{\sphinxupquote{Employee}}(name{[}, id{]})
&
Represents an employee.
\\
<< hline >>
\sphinxcode{\sphinxupquote{Movie}}(name, year, based\_on)
&
Represents a movie.
\\
<% if sphinx_version >= (5, 3) %>\sphinxbottomrule<% else %>\hline<% endif %>
<% if sphinx_version > (8, 2) -%>
\end{longtable}
\sphinxtableafterendhook
\sphinxatlongtableend
\end{savenotes}<% elif sphinx_version > (4, 5) -%>
\end{tabulary}
<< par >>
\sphinxattableend\end{savenotes}
<%- else -%>
\end{longtable}\sphinxatlongtableend\end{savenotes}
<%- endif %>


\bookmarksetupnext{{level=part}}

\renewcommand{\indexname}{Python Module Index}
\begin{sphinxtheindex}
\let\bigletter\sphinxstyleindexlettergroup
\bigletter{s}
\item\relax\sphinxstyleindexentry{sphinx\_toolbox.utils}\sphinxstyleindexpageref{regex:\detokenize{module-sphinx_toolbox.utils}}
\end{sphinxtheindex}

\bookmarksetupnext{{level=part}}

\renewcommand{\indexname}{Index}
\printindex
\end{document}
