File tree Expand file tree Collapse file tree 1 file changed +19
-0
lines changed Expand file tree Collapse file tree 1 file changed +19
-0
lines changed Original file line number Diff line number Diff line change @@ -77,3 +77,22 @@ extern crate ndarray;
77
77
extern crate ndarray_linalg;
78
78
extern crate openblas_src; // or another backend of your choice
79
79
```
80
+
81
+ Generate document with KaTeX
82
+ ------------------------------
83
+
84
+ You need to set ` RUSTDOCFLAGS ` explicitly:
85
+
86
+ ``` shell
87
+ RUSTDOCFLAGS=" --html-in-header katex-header.html" cargo doc --no-deps
88
+ ```
89
+
90
+ This ** only** works for ` --no-deps ` build because ` katex-header.html ` does not exists for dependent crates.
91
+ If you wish to set ` RUSTDOCFLAGS ` automatically in this crate, you can put [ .cargo/config] ( https://doc.rust-lang.org/cargo/reference/config.html ) :
92
+
93
+ ``` toml
94
+ [build ]
95
+ rustdocflags = [" --html-in-header" , " katex-header.html" ]
96
+ ```
97
+
98
+ But, be sure that this works only for ` --no-deps ` . ` cargo doc ` will fail with this ` .cargo/config ` .
You can’t perform that action at this time.
0 commit comments