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

LaTeX equation rendering in HTML documentation #58

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

lorenzschmid
Copy link
Contributor

Adapts the HTML documentation generation:

  • Replace any strings inside the description/comment fields wrapped by dollar signs ($ and $) indicating a LaTeX equation with inline delimiters (\( and \)) such that the equations can be detected by MathJax.
  • Adds new argument --doc-include-js-dep to allow insertion of external JavaScript dependencies:
    ...
    </STYLE>
    <script type="text/javascript" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml.js"></script>
    </HEAD>
    ...

Renders inline equations such as $f_s = \frac{30.72}{2} \text{MHz}$ as Matlab equations $f_s = \frac{30.72}{2} \text{MHz}$.

@tgingold-cern tgingold-cern merged commit 18cac19 into tgingold-cern:master Oct 3, 2024
2 checks passed
@tgingold-cern
Copy link
Owner

Thanks!

@lorenzschmid lorenzschmid deleted the html-js-dep branch October 3, 2024 11:26
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.

2 participants