Minimal Rust project example for getting Latex in docs
This approach use a HTML
header loading a script in the final HTML
doc pages. You need to set environmental variable RUSTDOCFLAGS
with paramenter html-in-header
to a fragment of HTML
file with the script that load and configure Katex
.
The html
file is something like this
In this minimal example repo is in src/docs-header.html
.
And you put Latex
in your docs like
/// $$E = mc^2 $$
/// $$m = \frac{m_0}{\sqrt{1-\frac{v^2}{c^2}}}$$
Compiling the docs manually (without .cargo/config
)
NIX kind
RUSTDOCFLAGS="--html-in-header src/docs-header.html"
Windows
cmd
set RUSTDOCFLAGS=--html-in-header src\docs-header.html
cargo doc --open
PowerShell
$env:RUSTDOCFLAGS="--html-in-header .\src\docs-header.html"
cargo doc --open
Compile and copy to docs
Because the solution could not work in docs.rs
, you can publish the docs on your own host.
This minimal example is hosted with github pages. You can see the docs generated, with LaTeX
at
minimal example docs with LaTex
&&