tools

Checks the readme syntax

The command line checks the readme syntax in virtual environments.

python -m sphinx_runpython readme -p <path_to_readme.rst> -v

It is based on function:

sphinx_runpython.readme.check_readme_syntax(readme: str, folder: str, version: str | None = None, verbose: int = 0) → str

Checks the syntax of the file readme.rst which describes a python project.

Parameters:

• readme – file to check

• folder – location for the virtual environment

• version – version of docutils

• verbose – verbosity

Returns:

output or SyntaxError exception

However, it is better to run command line twine check dist/* assuming the whl was built by a command such as python setup.py sdist.

Convert notebooks into examples

The command line converts every notebook in a folder into examples which can be used into a sphinx gallery.

python -m sphinx_runpython --help

Tools related to latex

sphinx_runpython.tools.latex_functions.build_regex(text: str | None = None) → Dict[str, str | Tuple[str, str]]

Parses a preamble in latex and builds regular expressions based on it.

sphinx_runpython.tools.latex_functions.replace_latex_command(text: str, patterns: Dict[str, str | Tuple[str, str]] | None = None, verbose: int = 0) → str

Replaces a latex by its raw expression.

Parameters:

• text – text

• patterns – one in the known list or None for all

• verbose – verbosity

Returns:

modified text

The default patterns are defined by:

<<<

from sphinx_runpython.tools.latex_functions import PREAMBLE

print(PREAMBLE)

>>>

    
    \newcommand{\vecteurno}[2]{#1,\dots,#2}
    \newcommand{\R}{\mathbb{R}}
    \newcommand{\pa}[1]{\left(#1\right)}
    \newcommand{\cro}[1]{\left[#1\right]}
    \newcommand{\acc}[1]{\left\{#1\right\}}
    \newcommand{\vecteur}[2]{\left(#1,\dots,#2\right)}
    \newcommand{\N}[0]{\mathbb{N}}
    \newcommand{\indicatrice}[1]{ {1\!\!1}_{\left\{#1\right\}} }
    \newcommand{\infegal}[0]{\leqslant}
    \newcommand{\supegal}[0]{\geqslant}
    \newcommand{\ensemble}[2]{\left\{#1,\dots,#2\right\}}
    \newcommand{\fleche}[1]{\overrightarrow{#1}}
    \newcommand{\intervalle}[2]{\left\{#1,\cdots,#2\right\}}
    \newcommand{\independent}[0]{\perp \!\!\! \perp}
    \newcommand{\esp}{\mathbb{E}}
    \newcommand{\espf}[2]{\mathbb{E}_{#1}\left(#2\right)}
    \newcommand{\var}{\mathbb{V}}
    \newcommand{\pr}[1]{\mathbb{P}\left(#1\right)}
    \newcommand{\loi}[0]{{\cal L}}
    \newcommand{\norm}[1]{\left\Vert#1\right\Vert}
    \newcommand{\norme}[1]{\left\Vert#1\right\Vert}
    \newcommand{\scal}[2]{\left<#1,#2\right>}
    \newcommand{\dans}[0]{\rightarrow}
    \newcommand{\partialfrac}[2]{\frac{\partial #1}{\partial #2}}
    \newcommand{\partialdfrac}[2]{\dfrac{\partial #1}{\partial #2}}
    \newcommand{\trace}[1]{tr\left(#1\right)}
    \newcommand{\sac}[0]{|}
    \newcommand{\abs}[1]{\left|#1\right|}
    \newcommand{\loinormale}[2]{{\cal N} \left(#1,#2\right)}
    \newcommand{\loibinomialea}[1]{{\cal B} \left(#1\right)}
    \newcommand{\loibinomiale}[2]{{\cal B} \left(#1,#2\right)}
    \newcommand{\loimultinomiale}[1]{{\cal M} \left(#1\right)}
    \newcommand{\variance}[1]{\mathbb{V}\left(#1\right)}
    \newcommand{\intf}[1]{\left\lfloor #1 \right\rfloor}

With gives:

<<<

import pprint
from sphinx_runpython.tools.latex_functions import build_regex

pprint.pprint(build_regex())

>>>

    {'N': '\\mathbb{N}',
     'R': '\\mathbb{R}',
     'abs': <function build_regex.<locals>.<lambda> at 0x7bbe581fd120>,
     'acc': <function build_regex.<locals>.<lambda> at 0x7bbe581ff100>,
     'cro': <function build_regex.<locals>.<lambda> at 0x7bbe581fee80>,
     'dans': '\\rightarrow',
     'ensemble': ('\\\\ensemble *\\{(.+?)\\}\\{(.+?)\\}',
                  '\\\\left\\\\{\\1,\\\\dots,\\2\\\\right\\\\}'),
     'esp': '\\mathbb{E}',
     'espf': ('\\\\espf *\\{(.+?)\\}\\{(.+?)\\}',
              '\\\\mathbb{E}_{\\1}\\\\left(\\2\\\\right)'),
     'fleche': ('\\\\fleche *\\{(.+?)\\}', '\\\\overrightarrow{\\1}'),
     'independent': '\\perp \\!\\!\\! \\perp',
     'indicatrice': ('\\\\indicatrice *\\{(.+?)\\}',
                     ' {1\\\\!\\\\!1}_{\\\\left\\\\{\\1\\\\right\\\\}} '),
     'infegal': '\\leqslant',
     'intervalle': ('\\\\intervalle *\\{(.+?)\\}\\{(.+?)\\}',
                    '\\\\left\\\\{\\1,\\\\cdots,\\2\\\\right\\\\}'),
     'intf': ('\\\\intf *\\{(.+?)\\}',
              '\\\\left\\\\lfloor \\1 \\\\right\\\\rfloor'),
     'loi': '{\\cal L}',
     'loibinomiale': ('\\\\loibinomiale *\\{(.+?)\\}\\{(.+?)\\}',
                      '{\\\\cal B} \\\\left(\\1,\\2\\\\right)'),
     'loibinomialea': ('\\\\loibinomialea *\\{(.+?)\\}',
                       '{\\\\cal B} \\\\left(\\1\\\\right)'),
     'loimultinomiale': ('\\\\loimultinomiale *\\{(.+?)\\}',
                         '{\\\\cal M} \\\\left(\\1\\\\right)'),
     'loinormale': ('\\\\loinormale *\\{(.+?)\\}\\{(.+?)\\}',
                    '{\\\\cal N} \\\\left(\\1,\\2\\\\right)'),
     'norm': ('\\\\norm *\\{(.+?)\\}', '\\\\left\\\\Vert\\1\\\\right\\\\Vert'),
     'norme': ('\\\\norme *\\{(.+?)\\}', '\\\\left\\\\Vert\\1\\\\right\\\\Vert'),
     'pa': <function build_regex.<locals>.<lambda> at 0x7bbe581fe480>,
     'partialdfrac': ('\\\\partialdfrac *\\{(.+?)\\}\\{(.+?)\\}',
                      '\\\\dfrac{\\\\partial \\1}{\\\\partial \\2}'),
     'partialfrac': ('\\\\partialfrac *\\{(.+?)\\}\\{(.+?)\\}',
                     '\\\\frac{\\\\partial \\1}{\\\\partial \\2}'),
     'pr': ('\\\\pr *\\{(.+?)\\}', '\\\\mathbb{P}\\\\left(\\1\\\\right)'),
     'sac': '|',
     'scal': ('\\\\scal *\\{(.+?)\\}\\{(.+?)\\}', '\\\\left<\\1,\\2\\\\right>'),
     'supegal': '\\geqslant',
     'trace': ('\\\\trace *\\{(.+?)\\}', 'tr\\\\left(\\1\\\\right)'),
     'var': '\\mathbb{V}',
     'variance': ('\\\\variance *\\{(.+?)\\}',
                  '\\\\mathbb{V}\\\\left(\\1\\\\right)'),
     'vecteur': ('\\\\vecteur *\\{(.+?)\\}\\{(.+?)\\}',
                 '\\\\left(\\1,\\\\dots,\\2\\\\right)'),
     'vecteurno': ('\\\\vecteurno *\\{(.+?)\\}\\{(.+?)\\}', '\\1,\\\\dots,\\2')}