NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

Commit2420e6a

committed

Refactor math_symbol_table.py to dynamically determine column number for symbol tables(Issue#26143)

- Remove hardcoded column numbers; now columns are auto-calculated based on symbol length and page width constraints. Future changes to symbol lists require no manual column adjustment.

1 parentdef8fa4 commit2420e6aCopy full SHA for 2420e6a

File tree

1 file changed

+47

-19

lines changed

doc/sphinxext
- math_symbol_table.py

1 file changed

+47

-19

lines changed

`‎doc/sphinxext/math_symbol_table.py`

Lines changed: 47 additions & 19 deletions

Original file line number	Diff line number	Diff line change
`@@ -9,57 +9,42 @@`
`9`	`9`
`10`	`10`	`symbols= [`
`11`	`11`	`["Lower-case Greek",`
`12`		`-4,`
`13`	`12`	`(r"\alpha",r"\beta",r"\gamma",r"\chi",r"\delta",r"\epsilon",`
`14`	`13`	`r"\eta",r"\iota",r"\kappa",r"\lambda",r"\mu",r"\nu",r"\omega",`
`15`	`14`	`r"\phi",r"\pi",r"\psi",r"\rho",r"\sigma",r"\tau",r"\theta",`
`16`	`15`	`r"\upsilon",r"\xi",r"\zeta",r"\digamma",r"\varepsilon",r"\varkappa",`
`17`	`16`	`r"\varphi",r"\varpi",r"\varrho",r"\varsigma",r"\vartheta")],`
`18`	`17`	`["Upper-case Greek",`
`19`		`-4,`
`20`	`18`	`(r"\Delta",r"\Gamma",r"\Lambda",r"\Omega",r"\Phi",r"\Pi",r"\Psi",`
`21`	`19`	`r"\Sigma",r"\Theta",r"\Upsilon",r"\Xi")],`
`22`	`20`	`["Hebrew",`
`23`		`-6,`
`24`	`21`	`(r"\aleph",r"\beth",r"\gimel",r"\daleth")],`
`25`	`22`	`["Latin named characters",`
`26`		`-6,`
`27`	`23`	`r"""\aa \AA \ae \AE \oe \OE \O \o \thorn \Thorn \ss \eth \dh \DH""".split()],`
`28`	`24`	`["Delimiters",`
`29`		`-5,`
`30`	`25`	`_mathtext.Parser._delims],`
`31`	`26`	`["Big symbols",`
`32`		`-5,`
`33`	`27`	`_mathtext.Parser._overunder_symbols\|_mathtext.Parser._dropsub_symbols],`
`34`	`28`	`["Standard function names",`
`35`		`-5,`
`36`	`29`	`{fr"\{fn}"forfnin_mathtext.Parser._function_names}],`
`37`	`30`	`["Binary operation symbols",`
`38`		`-4,`
`39`	`31`	`_mathtext.Parser._binary_operators],`
`40`	`32`	`["Relation symbols",`
`41`		`-4,`
`42`	`33`	`_mathtext.Parser._relation_symbols],`
`43`	`34`	`["Arrow symbols",`
`44`		`-4,`
`45`	`35`	`_mathtext.Parser._arrow_symbols],`
`46`	`36`	`["Dot symbols",`
`47`		`-4,`
`48`	`37`	`r"""\cdots \vdots \ldots \ddots \adots \Colon \therefore \because""".split()],`
`49`	`38`	`["Black-board characters",`
`50`		`-6,`
`51`	`39`	`[fr"\{symbol}"forsymbolin_mathtext_data.tex2uni`
`52`	`40`	`ifre.match(bb_pattern,symbol)]],`
`53`	`41`	`["Script characters",`
`54`		`-6,`
`55`	`42`	`[fr"\{symbol}"forsymbolin_mathtext_data.tex2uni`
`56`	`43`	`ifre.match(scr_pattern,symbol)]],`
`57`	`44`	`["Fraktur characters",`
`58`		`-6,`
`59`	`45`	`[fr"\{symbol}"forsymbolin_mathtext_data.tex2uni`
`60`	`46`	`ifre.match(frak_pattern,symbol)]],`
`61`	`47`	`["Miscellaneous symbols",`
`62`		`-4,`
`63`	`48`	`r"""\neg \infty \forall \wp \exists \bigstar \angle \partial`
`64`	`49`	`\nexists \measuredangle \emptyset \sphericalangle \clubsuit`
`65`	`50`	`\varnothing \complement \diamondsuit \imath \Finv \triangledown`
`@@ -73,6 +58,44 @@`
`73`	`58`	`]`
`74`	`59`
`75`	`60`
	`61`	`+defcalculate_best_columns(`
	`62`	`+symbols_list,max_line_length,min_columns,max_columns`
	`63`	`+):`
	`64`	`+"""`
	`65`	`+ Calculate the best number of columns to fit the symbols within the`
	`66`	`+ given constraints.`
	`67`	`+`
	`68`	`+ Parameters`
	`69`	`+ ----------`
	`70`	`+ symbols_list (list): A list of symbols to be displayed.`
	`71`	`+ max_line_length (int): The maximum allowed length of a line.`
	`72`	`+ min_columns (int): The minimum number of columns to consider.`
	`73`	`+ max_columns (int): The maximum number of columns to consider.`
	`74`	`+`
	`75`	`+ Returns`
	`76`	`+ -------`
	`77`	`+ int: The best number of columns that fits within the constraints.`
	`78`	`+ """`
	`79`	`+best_columns=min_columns`
	`80`	`+# Calculate the best number of columns`
	`81`	`+forcolumnsinrange(max_columns,min_columns-1,-1):`
	`82`	`+flag=False`
	`83`	`+foriinrange(0,len(symbols_list),columns):`
	`84`	`+line_length= (`
	`85`	`+sum(len(symbol)forsymbolinsymbols_list[i:i+columns])`
	`86`	`++columns-1`
	`87`	`+ )`
	`88`	`+# Check if the line length is less than or equal to max_line_length`
	`89`	`+ifline_length>max_line_length:`
	`90`	`+flag=True`
	`91`	`+break`
	`92`	`+ifnotflag:`
	`93`	`+best_columns=columns`
	`94`	`+break`
	`95`	`+max_cell_width=max(len(sym)forsyminsymbols_list)`
	`96`	`+returnmin(best_columns,len(symbols_list),max_line_length//max_cell_width)`
	`97`	`+`
	`98`	`+`
`76`	`99`	`defrun(state_machine):`
`77`	`100`
`78`	`101`	`defrender_symbol(sym,ignore_variant=False):`
`@@ -86,15 +109,21 @@ def render_symbol(sym, ignore_variant=False):`
`86`	`109`	`returnf'\\{sym}'ifsymin ('\\','\|','+','-','*')elsesym`
`87`	`110`
`88`	`111`	`lines= []`
`89`		`-forcategory,columns,symsinsymbols:`
	`112`	`+forcategory,symsinsymbols:`
`90`	`113`	`syms=sorted(syms,`
`91`	`114`	`# Sort by Unicode and place variants immediately`
`92`	`115`	`# after standard versions.`
`93`	`116`	`key=lambdasym: (render_symbol(sym,ignore_variant=True),`
`94`	`117`	`sym.startswith(r"\var")),`
`95`	`118`	`reverse=(category=="Hebrew"))# Hebrew is rtl`
`96`	`119`	rendered_syms= [f"{render_symbol(sym)} ``{sym}``"forsyminsyms]
`97`		`-columns=min(columns,len(syms))`
	`120`	`+max_line_length=95`
	`121`	`+columns=calculate_best_columns(`
	`122`	`+rendered_syms,`
	`123`	`+max_line_length=max_line_length,`
	`124`	`+min_columns=4,`
	`125`	`+max_columns=6`
	`126`	`+ )`
`98`	`127`	`lines.append("%s"%category)`
`99`	`128`	`lines.append('')`
`100`	`129`	`max_width=max(map(len,rendered_syms))`
`@@ -128,13 +157,12 @@ def setup(app):`
`128`	`157`	`metadata= {'parallel_read_safe':True,'parallel_write_safe':True}`
`129`	`158`	`returnmetadata`
`130`	`159`
`131`		`-`
`132`	`160`	`if__name__=="__main__":`
`133`	`161`	`# Do some verification of the tables`
`134`	`162`
`135`	`163`	`print("SYMBOLS NOT IN STIX:")`
`136`	`164`	`all_symbols= {}`
`137`		`-forcategory,columns,symsinsymbols:`
	`165`	`+forcategory,symsinsymbols:`
`138`	`166`	`ifcategory=="Standard Function Names":`
`139`	`167`	`continue`
`140`	`168`	`forsyminsyms:`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit2420e6a

File tree

1 file changed

1 file changed

`‎doc/sphinxext/math_symbol_table.py`

0 commit comments