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 support #28

Closed
koaning opened this issue Feb 10, 2019 · 1 comment

Comments

2 participants
@koaning
Copy link

commented Feb 10, 2019

Does pdoc3 offer mathematical rendering via something like MathJax? I wouldn't know how to implement it but I'd be willing to investigate if people are open to this feature.

@kernc kernc added the question label Feb 13, 2019

@kernc

This comment has been minimized.

Copy link
Contributor

commented Feb 13, 2019

This use case had been accounted for. You should be able to make a template file head.mako with contents like:

<script async defer src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>

Then run pdoc with --template-dir pointing to the directory containing this overridden template file (see custom templating documentation).

Afterwards, $$-delimited LaTeX blocks should render in symbols.

@kernc kernc closed this Feb 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.