Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

DOC: Dynamically resize mathtext symbol tables (#26143)#30682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Open
0NIKHIL0 wants to merge3 commits intomatplotlib:main
base:main
Choose a base branch
Loading
from0NIKHIL0:dynamic-symbol-table
Open
Show file tree
Hide file tree
Changes fromall commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
240 changes: 98 additions & 142 deletionsdoc/sphinxext/math_symbol_table.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,108 @@
import re
from docutils.parsers.rst import Directive
"""
Sphinx extension that generates the math symbol table documentation
for Matplotlib.
"""
from __future__ import annotations
from textwrap import dedent
from docutils.statemachine import StringList
from docutils import nodes
from sphinx.util.docutils import SphinxDirective
from matplotlib import _mathtext

from matplotlib import _mathtext, _mathtext_data

bb_pattern = re.compile("Bbb[A-Z]")
scr_pattern = re.compile("scr[a-zA-Z]")
frak_pattern = re.compile("frak[A-Z]")
class MathSymbolTableDirective(SphinxDirective):
"""Generate tables of math symbols grouped by category."""

symbols = [
["Lower-case Greek",
4,
(r"\alpha", r"\beta", r"\gamma", r"\chi", r"\delta", r"\epsilon",
r"\eta", r"\iota", r"\kappa", r"\lambda", r"\mu", r"\nu", r"\omega",
r"\phi", r"\pi", r"\psi", r"\rho", r"\sigma", r"\tau", r"\theta",
r"\upsilon", r"\xi", r"\zeta", r"\digamma", r"\varepsilon", r"\varkappa",
r"\varphi", r"\varpi", r"\varrho", r"\varsigma", r"\vartheta")],
["Upper-case Greek",
4,
(r"\Delta", r"\Gamma", r"\Lambda", r"\Omega", r"\Phi", r"\Pi", r"\Psi",
r"\Sigma", r"\Theta", r"\Upsilon", r"\Xi")],
["Hebrew",
6,
(r"\aleph", r"\beth", r"\gimel", r"\daleth")],
["Latin named characters",
6,
r"""\aa \AA \ae \AE \oe \OE \O \o \thorn \Thorn \ss \eth \dh \DH""".split()],
["Delimiters",
5,
_mathtext.Parser._delims],
["Big symbols",
5,
_mathtext.Parser._overunder_symbols | _mathtext.Parser._dropsub_symbols],
["Standard function names",
5,
{fr"\{fn}" for fn in _mathtext.Parser._function_names}],
["Binary operation symbols",
4,
_mathtext.Parser._binary_operators],
["Relation symbols",
4,
_mathtext.Parser._relation_symbols],
["Arrow symbols",
4,
_mathtext.Parser._arrow_symbols],
["Dot symbols",
4,
r"""\cdots \vdots \ldots \ddots \adots \Colon \therefore \because""".split()],
["Black-board characters",
6,
[fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(bb_pattern, symbol)]],
["Script characters",
6,
[fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(scr_pattern, symbol)]],
["Fraktur characters",
6,
[fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(frak_pattern, symbol)]],
["Miscellaneous symbols",
4,
r"""\neg \infty \forall \wp \exists \bigstar \angle \partial
\nexists \measuredangle \emptyset \sphericalangle \clubsuit
\varnothing \complement \diamondsuit \imath \Finv \triangledown
\heartsuit \jmath \Game \spadesuit \ell \hbar \vartriangle
\hslash \blacksquare \blacktriangle \sharp \increment
\prime \blacktriangledown \Im \flat \backprime \Re \natural
\circledS \P \copyright \circledR \S \yen \checkmark \$
\cent \triangle \QED \sinewave \dag \ddag \perthousand \ac
\lambdabar \L \l \degree \danger \maltese \clubsuitopen
\i \hermitmatrix \sterling \nabla \mho""".split()],
]


def run(state_machine):

def render_symbol(sym, ignore_variant=False):
if ignore_variant and sym not in (r"\varnothing", r"\varlrtriangle"):
sym = sym.replace(r"\var", "\\")
if sym.startswith("\\"):
sym = sym.lstrip("\\")
if sym not in (_mathtext.Parser._overunder_functions |
_mathtext.Parser._function_names):
sym = chr(_mathtext_data.tex2uni[sym])
return f'\\{sym}' if sym in ('\\', '|', '+', '-', '*') else sym

lines = []
for category, columns, syms in symbols:
syms = sorted(syms,
# Sort by Unicode and place variants immediately
# after standard versions.
key=lambda sym: (render_symbol(sym, ignore_variant=True),
sym.startswith(r"\var")),
reverse=(category == "Hebrew")) # Hebrew is rtl
rendered_syms = [f"{render_symbol(sym)} ``{sym}``" for sym in syms]
columns = min(columns, len(syms))
lines.append("**%s**" % category)
lines.append('')
max_width = max(map(len, rendered_syms))
header = (('=' * max_width) + ' ') * columns
lines.append(header.rstrip())
for part in range(0, len(rendered_syms), columns):
row = " ".join(
sym.rjust(max_width) for sym in rendered_syms[part:part + columns])
lines.append(row)
lines.append(header.rstrip())
lines.append('')

state_machine.insert_input(lines, "Symbol table")
return []


class MathSymbolTableDirective(Directive):
has_content = False
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = False
option_spec = {}

def run(self):
return run(self.state_machine)
# Build RST lines to be parsed. We include a small CSS style and
# simple HTML wrappers so the result is responsive in the browser.
lines: list[str] = []

# Add responsive CSS styling
style = dedent(
"\n".join(
[
"",
"",
".mpl-symbol-grid {",
" display: grid;",
" grid-template-columns: repeat(auto-fill, minmax(200px, 1fr));",
" gap: 8px;",
" margin: 16px 0;",
"}",
".mpl-symbol-cell {",
" display: flex;",
" flex-direction: column;",
" align-items: center;",
" padding: 8px;",
" border: 1px solid #ddd;",
" border-radius: 4px;",
"}",
".mpl-symbol-cell .math {",
" font-size: 1.2em;",
" margin-bottom: 4px;",
"}",
".mpl-symbol-cell .label {",
" font-family: monospace;",
" font-size: 0.9em;",
" color: #666;",
"}",
"",
"",
]
)
)

# Insert the style as raw HTML block
lines.append(".. raw:: html")
lines.append("")
for style_line in style.splitlines():
lines.append(" " + style_line)
lines.append("")

# Get symbol categories from matplotlib mathtext internals
try:
categories = _mathtext._get_sphinx_symbol_table()
except Exception:
categories = []

for category, _, syms in categories:
# Ensure consistent ordering for reproducible output
syms_list = sorted(list(syms), key=lambda s: str(s))

lines.append(f"**{category}**")
lines.append("")
lines.append(".. raw:: html")
lines.append("")
lines.append(' <div class="mpl-symbol-grid" node="_65">')
lines.append(' ')

for sym in syms_list:
s = str(sym)
# Use raw TeX inside \( ... \) so MathJax (Sphinx) renders it
tex = s
html_line = (
' <div class="mpl-symbol-cell" node="_74">'
f'<span class="math" node="_76">\\({tex}\\)</span>'
f'<span class="label" node="_78">`{s}`</span>'
"</div>"
)
lines.append(html_line)

lines.append(" </div>")
lines.append(" ")
lines.append("")

# Let Sphinx parse the lines so roles and references work
text = "\n".join(lines)
node = nodes.paragraph()
self.state.nested_parse(StringList(text.splitlines()), 0, node)
return [node]


def setup(app):
"""Register the Sphinx directive."""
app.add_directive("math_symbol_table", MathSymbolTableDirective)

metadata = {'parallel_read_safe': True, 'parallel_write_safe': True}
return metadata


if __name__ == "__main__":
# Do some verification of the tables

print("SYMBOLS NOT IN STIX:")
all_symbols = {}
for category, columns, syms in symbols:
if category == "Standard Function Names":
continue
for sym in syms:
if len(sym) > 1:
all_symbols[sym[1:]] = None
if sym[1:] not in _mathtext_data.tex2uni:
print(sym)

# Add accents
all_symbols.update({v[1:]: k for k, v in _mathtext.Parser._accent_map.items()})
all_symbols.update({v: v for v in _mathtext.Parser._wide_accents})
print("SYMBOLS NOT IN TABLE:")
for sym, val in _mathtext_data.tex2uni.items():
if sym not in all_symbols:
print(f"{sym} = {chr(val)}")
return {"parallel_read_safe": True, "parallel_write_safe": True}
67 changes: 67 additions & 0 deletionslib/matplotlib/_mathtext.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2840,3 +2840,70 @@
vlt = Vlist(stack)
result = [Hlist([vlt])]
return result






def _get_sphinx_symbol_table():
"""
Return symbol categories for documentation generation.

Check warning on line 2852 in lib/matplotlib/_mathtext.py

View workflow job for this annotation

GitHub Actions/ ruff

[rdjson] reported by reviewdog 🐶Blank line contains whitespaceRaw Output:message:"Blank line contains whitespace"  location:{path:"/home/runner/work/matplotlib/matplotlib/lib/matplotlib/_mathtext.py"  range:{start:{line:2852  column:1}  end:{line:2852  column:5}}}  severity:WARNING  source:{name:"ruff"  url:"https://docs.astral.sh/ruff"}  code:{value:"W293"  url:"https://docs.astral.sh/ruff/rules/blank-line-with-whitespace"}  suggestions:{range:{start:{line:2852  column:1}  end:{line:2852  column:5}}}
Returns
-------
list of tuples
Each tuple contains (category_name, columns, symbol_set)
"""
import re
from matplotlib import _mathtext_data

Check warning on line 2860 in lib/matplotlib/_mathtext.py

View workflow job for this annotation

GitHub Actions/ ruff

[rdjson] reported by reviewdog 🐶Blank line contains whitespaceRaw Output:message:"Blank line contains whitespace"  location:{path:"/home/runner/work/matplotlib/matplotlib/lib/matplotlib/_mathtext.py"  range:{start:{line:2860  column:1}  end:{line:2860  column:5}}}  severity:WARNING  source:{name:"ruff"  url:"https://docs.astral.sh/ruff"}  code:{value:"W293"  url:"https://docs.astral.sh/ruff/rules/blank-line-with-whitespace"}  suggestions:{range:{start:{line:2860  column:1}  end:{line:2860  column:5}}}
bb_pattern = re.compile("Bbb[A-Z]")
scr_pattern = re.compile("scr[a-zA-Z]")
frak_pattern = re.compile("frak[A-Z]")

Check warning on line 2864 in lib/matplotlib/_mathtext.py

View workflow job for this annotation

GitHub Actions/ ruff

[rdjson] reported by reviewdog 🐶Blank line contains whitespaceRaw Output:message:"Blank line contains whitespace"  location:{path:"/home/runner/work/matplotlib/matplotlib/lib/matplotlib/_mathtext.py"  range:{start:{line:2864  column:1}  end:{line:2864  column:5}}}  severity:WARNING  source:{name:"ruff"  url:"https://docs.astral.sh/ruff"}  code:{value:"W293"  url:"https://docs.astral.sh/ruff/rules/blank-line-with-whitespace"}  suggestions:{range:{start:{line:2864  column:1}  end:{line:2864  column:5}}}
return [
["Lower-case Greek", 4,
{r"\alpha", r"\beta", r"\gamma", r"\chi", r"\delta", r"\epsilon",
r"\eta", r"\iota", r"\kappa", r"\lambda", r"\mu", r"\nu", r"\omega",
r"\phi", r"\pi", r"\psi", r"\rho", r"\sigma", r"\tau", r"\theta",
r"\upsilon", r"\xi", r"\zeta", r"\digamma", r"\varepsilon", r"\varkappa",
r"\varphi", r"\varpi", r"\varrho", r"\varsigma", r"\vartheta"}],
["Upper-case Greek", 4,
{r"\Delta", r"\Gamma", r"\Lambda", r"\Omega", r"\Phi", r"\Pi", r"\Psi",
r"\Sigma", r"\Theta", r"\Upsilon", r"\Xi"}],
["Hebrew", 6,
{r"\aleph", r"\beth", r"\gimel", r"\daleth"}],
["Latin named characters", 6,
set(r"\aa \AA \ae \AE \oe \OE \O \o \thorn \Thorn \ss \eth \dh \DH".split())],
["Delimiters", 5, Parser._delims],
["Big symbols", 5, Parser._overunder_symbols | Parser._dropsub_symbols],
["Standard function names", 5,
{fr"\{fn}" for fn in Parser._function_names}],
["Binary operation symbols", 4, Parser._binary_operators],
["Relation symbols", 4, Parser._relation_symbols],
["Arrow symbols", 4, Parser._arrow_symbols],
["Dot symbols", 4,
set(r"\cdots \vdots \ldots \ddots \adots \Colon \therefore \because".split())],
["Black-board characters", 6,
{fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(bb_pattern, symbol)}],
["Script characters", 6,
{fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(scr_pattern, symbol)}],
["Fraktur characters", 6,
{fr"\{symbol}" for symbol in _mathtext_data.tex2uni
if re.match(frak_pattern, symbol)}],
["Miscellaneous symbols", 4,
set(r"""\neg \infty \forall \wp \exists \bigstar \angle \partial
\nexists \measuredangle \emptyset \sphericalangle \clubsuit
\varnothing \complement \diamondsuit \imath \Finv \triangledown
\heartsuit \jmath \Game \spadesuit \ell \hbar \vartriangle
\hslash \blacksquare \blacktriangle \sharp \increment
\prime \blacktriangledown \Im \flat \backprime \Re \natural
\circledS \P \copyright \circledR \S \yen \checkmark \$
\cent \triangle \QED \sinewave \dag \ddag \perthousand \ac
\lambdabar \L \l \degree \danger \maltese \clubsuitopen
\i \hermitmatrix \sterling \nabla \mho""".split())],
]

Loading
[8]ページ先頭
©2009-2025 Movatter.jp