Add support for masks to template matching and support for LaTeX in d…

…ocs (#568)


---------

Co-authored-by: daladim <[email protected]>

Cargo.toml

@@ -33,6 +33,7 @@ rand_distr = "0.4.3"
 rayon = { version = "1.8.0", optional = true }
 quickcheck = { version = "1.0.3", optional = true }
 sdl2 = { version = "0.36", optional = true, default-features = false, features = ["bundled"] }
+katexit = { version = "0.1.4", optional = true }
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 getrandom = { version = "0.2", features = ["js"] }
@@ -45,7 +46,7 @@ wasm-bindgen-test = "0.3.38"
 [package.metadata.docs.rs]
 # See https://github.com/image-rs/imageproc/issues/358
 # all-features = true
-features = [ "property-testing" ]
+features = [ "property-testing", "katexit" ]
 
 [profile.release]
 opt-level = 3

README.md

@@ -47,3 +47,11 @@ All pull requests are welcome. Some specific areas that would be great to get so
 * APIs - are the current APIs hard to use or inconsistent? Some open questions: Should we return Result types more often? How should functions indicate acceptable input image dimensions? Should we use enum arguments or have lots of similarly named functions? What's the best way to get concise code while still allowing control over allocations?
 * Documentation - particularly more example code showing what's currently possible. Pretty pictures in this README.
 * Feature requests - are there any functions you'd like to see added? Is the library currently unsuitable for your use case for some reason?
+
+## Documentation
+
+This crate uses `katexit` to render equations in the documentation.
+To open the documentation locally with `katexit` enabled, use
+```sh
+cargo doc --open --features=katexit
+```