From 97637bffb09a6ef46a66b47207df5a18e3e7afc0 Mon Sep 17 00:00:00 2001 From: Denis Pisarev Date: Wed, 29 Jun 2022 13:16:59 +0200 Subject: [PATCH] docs: add rustdoc hint (#764) --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 31def8a4a..f3f633458 100644 --- a/README.md +++ b/README.md @@ -240,6 +240,7 @@ The default is `gh-pages`. ### ⭐️ Source Directory `publish_dir` A source directory to deploy to GitHub Pages. The default is `public`. +Only the contents of this dir are pushed to GitHub Pages branch, `gh-pages` by default. ```yaml - name: Deploy @@ -1035,6 +1036,10 @@ jobs: publish_dir: ./book ``` +Hint: you may want to publish your rustdocs. And use relative links to it from the md docs, and have them checked by `mdbook`. +Then, according to the [doc](https://rust-lang.github.io/mdBook/guide/creating.html#source-files), you may put `./target/doc/` +to your `./book/src` dir before you `mdbook build` and then it will end up in `./book/html/` and in your Github Pages. + ### ⭐️ Flutter Web An example workflow for [Flutter web project].