Document cl for building the doc locally

unageek · Mar 1, 2022 · f76eea8 · f76eea8
1 parent 540a2cc
commit f76eea8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,14 @@ When using the Cargo feature `gmp` (see below), target platforms are limited to
 
 ## [Changelog](CHANGELOG.md)
 
+## Building the Documentation Locally
+
+```bash
+RUSTDOCFLAGS="--cfg docsrs --html-in-header /path/to/src/_docs/header.html" cargo doc --open
+```
+
+The absolute path is required for `header.html`.
+
 ## Related Projects
 
 - [Graphest](https://github.com/unageek/graphest) - A faithful graphing calculator