From f76eea8f346bce586bb52e26cf4cd2b47432e192 Mon Sep 17 00:00:00 2001 From: unageek <29035331+unageek@users.noreply.github.com> Date: Tue, 1 Mar 2022 20:00:09 +0900 Subject: [PATCH] Document cl for building the doc locally --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 824fee6..a53bd6a 100644 --- 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