Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: allow TeX in Style function docs #1592

Merged
merged 1 commit into from Jul 31, 2023
Merged

docs: allow TeX in Style function docs #1592

merged 1 commit into from Jul 31, 2023

Conversation

wodeni
Copy link
Member

@wodeni wodeni commented Jul 31, 2023

Description

Our main site uses KaTeX (#926) to allow math notations in markdown. This PR add support for math notations in the core Style function library docs as well.

@cloudflare-pages
Copy link

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5b47aae
Status: ✅  Deploy successful!
Preview URL: https://bc9bce2b.penrose-72l.pages.dev
Branch Preview URL: https://docs-func-tex.penrose-72l.pages.dev

View logs

@github-actions
Copy link

± Registry diff

📊 Performance

Key

Note that each bar component rounds up to the nearest 100ms, so each full bar is an overestimate by up to 400ms.

     0s   1s   2s   3s   4s   5s   6s
     |    |    |    |    |    |    |
name ▝▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▄▞▀▀▀▀▀▀▀▀▀▘
      compiling optimizing rendering

If a row has only one bar instead of four, that means it's not a trio and the bar just shows the total time spent for that example, again rounded up to the nearest 100ms.

Data

                                                          0s   1s   2s   3s   4s   5s   6s   7s   8s
                                                          |    |    |    |    |    |    |    |    |
set-theory-domain/tree-venn                               ▝▀▀▚▘
set-theory-domain/tree-tree                               ▝▀▀▞
group-theory/quaternion-multiplication-table              ▝▀▀▀▀▚▀▀
walk-on-spheres/SignedAngleOutside                        ▝▀▀▀▀▚▀
spectral-graphs/examples/hypercube                        ▝▀▀▚▀
group-theory/quaternion-cayley-graph                      ▝▀▚▀
set-theory-domain/tree-venn-3d                            ▝▀▞▘
atoms-and-bonds/one-water-molecule                        ▝▞
structural-formula/molecules/caffeine                     ▝▀▀▀▀▚▄▀▀
walk-on-spheres/walk-on-stars                             ▝▀▀▀▀▀▀▀▞▀▀▀
set-theory-domain/continuousmap                           ▝▚▘
mobius/mobius                                             ▝▚▘
linear-algebra-domain/two-vectors-perp                    ▝▚▘
tutorials/tutorial1                                       ▝▞
tutorials/tutorial2                                       ▝▞
tutorials/tutorial3                                       ▝▞
molecules/nitricacid-lewis                                ▝▀▀▀▚▘
exterior-algebra/vector-wedge                             ▝▚▘
shape-spec/all-shapes                                     ▝▚▀
shape-spec/arrowheads                                     ▝▞
graph-domain/textbook/sec1/fig1                           ▝▀▀▀▚▄▘
graph-domain/textbook/sec1/fig2                           ▝▀▀▀▚▄▞
graph-domain/textbook/sec1/fig3                           ▝▀▀▀▀▄▄▞
graph-domain/textbook/sec1/fig4                           ▝▀▀▀▀▚▄▄▘
spectral-graphs/examples/hexagonal-lattice                ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▄▞▀▀
graph-domain/textbook/sec1/fig5                           ▝▀▀▀▀▀▀▄▄▄▄▞
graph-domain/textbook/sec1/fig6                           ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▞
graph-domain/textbook/sec1/fig7                           ▝▀▀▄▘
graph-domain/textbook/sec1/fig8a                          ▝▀▀▀▀▀▀▄▄▄▘
graph-domain/textbook/sec1/fig8b                          ▝▀▀▀▀▚▄▄▞
graph-domain/textbook/sec1/fig9                           ▝▀▀▀▄▀
graph-domain/textbook/sec1/fig10                          ▝▀▀▀▄▘
graph-domain/textbook/sec1/fig11                          ▝▀▀▀▀▚▄▀▘
graph-domain/textbook/sec1/fig12                          ▝▀▀▀▀▀▀▀▄▄▄▀
graph-domain/textbook/sec1/fig13                          ▝▀▀▀▀▀▄▄▞
graph-domain/textbook/sec2/fig3                           ▝▀▀▀▀▀▀▀▀▚▄▄▄▄▞
graph-domain/textbook/sec2/fig4                           ▝▀▀▀▀▀▀▀▄▄▄▞
graph-domain/textbook/sec2/fig5                           ▝▀▀▀▀▀▀▀▀▚▄▄▄▄▞
graph-domain/textbook/sec2/fig6                           ▝▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▘
graph-domain/textbook/sec2/fig9                           ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▞
graph-domain/textbook/sec2/fig10a                         ▝▀▀▀▄▄▘
graph-domain/textbook/sec2/fig10b                         ▝▀▀▀▄▀
graph-domain/textbook/sec2/fig11a                         ▝▀▚▘
graph-domain/textbook/sec2/fig11b                         ▝▀▚▘
graph-domain/textbook/sec2/fig11c                         ▝▀▀▞
graph-domain/textbook/sec2/fig12                          ▝▀▚▘
graph-domain/textbook/sec2/fig13                          ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▞
graph-domain/textbook/sec2/fig14                          ▝▀▀▀▀▄▄▘
graph-domain/textbook/sec2/fig16b                         ▝▀▀▀▚▀
geometry-domain/textbook_problems/c05p13                  ▝▀▀▞
geometry-domain/textbook_problems/c01p01                  ▝▀▀▞
geometry-domain/textbook_problems/c03p01                  ▝▀▀▞
geometry-domain/textbook_problems/c05p01                  ▝▀▀▞
geometry-domain/textbook_problems/ex                      ▝▀▀▀▚▞
triangle-mesh-3d/two-triangles                            ▝▀▞
random-sampling/test                                      ▝▀▀▀▀▞
geometry-domain/textbook_problems/c11p12                  ▝▀▀▚▞
curve-examples/catmull-rom/catmull-rom                    ▝▚▘
word-cloud/example                                        ▝▀▀▄▞
geometry-domain/siggraph-teaser                           ▝▀▀▀▚▘
minkowski-tests/maze/non-convex                           ▝▀▞
lagrange-bases/lagrange-bases                             ▝▚▘
hypergraph/hypergraph                                     ▝▀▀▀▀▄▄▄▄▄▄▄▄▄▞
persistent-homology/persistent-homology                   ▝▀▀▚▄▄▄▀▘
walk-on-spheres/laplace-estimator                         ▝▀▀▚▘
walk-on-spheres/poisson-estimator                         ▝▀▀▀▞
walk-on-spheres/nested-estimator                          ▝▀▀▀▀▚▀
walk-on-spheres/offcenter-estimator                       ▝▀▀▚▘
shape-distance/points-around-star                         ▝▀▀▀▚▀
shape-distance/points-around-polyline                     ▝▀▀▚▘
shape-distance/points-around-line                         ▝▀▀▞
shape-distance/lines-around-rect                          ▝▀▞
fake-3d-linear-algebra/projection                         ▝▚▘
animation/center-shrink-circle                            ▝▞
graph-domain/other-examples/hamiltonian-cycle             ▝▀▀▀▀▀▄▄▘
structural-formula/reactions/methane-combustion           ▝▀▀▀▀▚▄▄▄▄▘
molecules/glutamine                                       ▝▀▚▘
matrix-ops/tests/matrix-matrix-addition                   ▝▀▞
matrix-ops/tests/matrix-matrix-division-elementwise       ▝▀▞
matrix-ops/tests/matrix-matrix-multiplication-elementwise ▝▀▞
matrix-ops/tests/matrix-matrix-multiplication             ▝▀▞
matrix-ops/tests/matrix-matrix-subtraction                ▝▀▞
matrix-ops/tests/matrix-transpose                         ▝▀▞
matrix-ops/tests/matrix-vector-left-multiplication        ▝▀▞
matrix-ops/tests/matrix-vector-right-multiplication       ▝▀▞
matrix-ops/tests/scalar-vector-division                   ▝▀▞
matrix-ops/tests/scalar-vector-left-multiplication        ▝▀▚▘
matrix-ops/tests/scalar-vector-right-multiplication       ▝▀▞
matrix-ops/tests/vector-vector-addition                   ▝▀▞
matrix-ops/tests/vector-vector-division-elementwise       ▝▀▞
matrix-ops/tests/vector-vector-multiplication-elementwise ▝▀▞
matrix-ops/tests/vector-vector-outerproduct               ▝▀▞
matrix-ops/tests/vector-vector-subtraction                ▝▀▞
logic-circuit-domain/half-adder                           ▝▀▀▞
curve-examples/cubic-bezier                               ▝▀▚▄▞
triangle-mesh-2d/diagrams/cotan-formula                   ▝▀▀▞
triangle-mesh-2d/diagrams/concyclic-pair                  ▝▀▚▘
triangle-mesh-2d/diagrams/halfedge-mesh                   ▝▀▚▘
triangle-mesh-2d/diagrams/relative-orientation            ▝▀▚▘
triangle-mesh-2d/diagrams/triangle-centers                ▝▀▞
triangle-mesh-2d/diagrams/angle-equivalence               ▝▀▀▚▄▄▘
timeline/penrose                                          ▝▀▀▀▀▚▞
graph-domain/textbook/sec5/ex32                           ▝▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▄▄▄▘
curve-examples/open-elastic-curve                         ▝▀▀▄▞
curve-examples/closed-elastic-curve                       ▝▀▀▄▞
graph-domain/other-examples/arpanet                       ▝▀▀▀▀▀▀▀▀▀▀▄▄▄▄▄▄▄▄▄▄▀
graph-domain/other-examples/nyc-subway                    ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▞
fancy-text/fancy-text                                     ▝▀▀▚▄▘
curve-examples/blobs                                      ▝▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▘
curve-examples/space-curves                               ▝▀▀▀▀▀▀▀▄▄▄▘
geometric-queries/ray-intersect/test-group                ▝▀▀▀▀▀▀▀▀▀▀▚▀
ray-tracing/path-trace                                    ▝▀▀▚▘
ray-tracing/bidirectional                                 ▝▀▀▚▘
ray-tracing/next-event-estimation                         ▝▀▀▀▚▀
geometric-queries/test                                    ▝▀▀▞
geometric-queries/closest-point/test-group                ▝▀▞
geometric-queries/closest-point/test                      ▝▚▘
geometric-queries/closest-silhouette-point/test           ▝▚▘
geometric-queries/ray-intersect/test                      ▝▀▀▀▀▀▀▀▀▚▀▀▘
box-arrow-diagram/computer-architecture                   ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▘
stochastic-process/stochastic-process                     ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▞▀▀▀▀▘
stochastic-process/epsilon-shell/AbsorbingBoundary        ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▞▀▀▀▀▀▀▀▀▀▘
solid/eigenspace                                          ▐██
solid/triangles                                           ▐█▌
solid/vectors                                             ▐█
tsne/tsne                                                 ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▄▄▄▄▄▄▄▄▞▀▀▀▀▀▀▀▀▀▘
spectral-graphs/examples/4x4-sudoku-graph                 ▝▀▀▀▞▘
spectral-graphs/examples/dodecahedral-graph               ▝▀▚▀
atoms-and-bonds/wet-floor                                 ▝▀▄▘
curve-examples/offset                                     ▝▀▄▞
curve-examples/frenet-frame                               ▝▀▞
curve-examples/osculating-circle                          ▝▚▘
curve-examples/evolute-of-cardioid                        ▝▀▀▀▞
spectral-graphs/examples/truncated-cube-graph             ▝▀▀▞
spectral-graphs/examples/torus                            ▝▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▚▄▄▀▀
spectral-graphs/examples/periodic-hexagonal-lattice       ▝▀▀▀▀▀▀▀▀▄▞▘
alloy-models/dining-philosophers                          ▝▚▘
alloy-models/message-passing                              ▝▀▀▀▀▄▄▄▄▞
alloy-models/ring-leader-election                         ▝▚▘
alloy-models/river-crossing                               ▝▞▀▀▀
alloy-models/workstations                                 ▝▀▄▞
alloy-models/generic                                      ▝▀▀▀▀▀▀▀▚▄▄▄▄▘

@keenancrane
Copy link
Collaborator

Thank you @wodeni! Since this is just a tiny change to one file (and I assume you know what you're doing!), I'm gonna take a leap of faith and just Squash & Merge it so I can use it immediately for the docs I'm adding in my branch. Thanks again!

@keenancrane keenancrane merged commit 95ab946 into main Jul 31, 2023
10 checks passed
@keenancrane keenancrane deleted the docs-func-tex branch July 31, 2023 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants