From d8562cbb5f6250efcf03673920e5c5814f83a999 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Wed, 1 Nov 2023 17:25:50 +0000 Subject: [PATCH 1/2] Fix unintended change to the output directory. Signed-off-by: Daira Emma Hopwood --- .github/workflows/render-site.yaml | 4 ++-- .gitignore | 3 ++- book.toml | 2 +- docs | 1 + 4 files changed, 6 insertions(+), 4 deletions(-) create mode 120000 docs diff --git a/.github/workflows/render-site.yaml b/.github/workflows/render-site.yaml index f4b0706..c268ca4 100644 --- a/.github/workflows/render-site.yaml +++ b/.github/workflows/render-site.yaml @@ -60,8 +60,8 @@ jobs: - run: mdbook build - name: Rendered manifest run: find ./docs -type f -exec ls -ld '{}' \; - - name: Unignore docs and generated images - run: sed -i 's|^docs/$||; s|^\*\.generated\.svg$||' .gitignore ; cat .gitignore + - name: Unignore html and generated images + run: sed -i 's|^html/$||; s|^\*\.generated\.svg$||' .gitignore ; cat .gitignore - name: Disable jekyll run: touch .nojekyll - name: Commit and Push render to gh-pages diff --git a/.gitignore b/.gitignore index e1632c1..4f4803b 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ -docs/ +html/ +linkcheck/ *.generated.svg diff --git a/book.toml b/book.toml index 8e04a07..28b924b 100644 --- a/book.toml +++ b/book.toml @@ -7,7 +7,7 @@ title = "Zcash Trailing Finality Layer" [build] # Follow gh pages convention; see https://nathan-at-least.github.io/auto-deploy-howto.html -build-dir = "./docs" +build-dir = "." [output.html] default-theme = "light" diff --git a/docs b/docs new file mode 120000 index 0000000..724f4d4 --- /dev/null +++ b/docs @@ -0,0 +1 @@ +html \ No newline at end of file From 199eedf5d3fbef4a25e7248afd9279f604c3fda0 Mon Sep 17 00:00:00 2001 From: Daira Emma Hopwood Date: Wed, 1 Nov 2023 17:35:46 +0000 Subject: [PATCH 2/2] Improve comments in `book.toml`. Co-authored-by: nate Signed-off-by: Daira Emma Hopwood --- book.toml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/book.toml b/book.toml index 28b924b..f041f67 100644 --- a/book.toml +++ b/book.toml @@ -6,7 +6,9 @@ src = "src" title = "Zcash Trailing Finality Layer" [build] -# Follow gh pages convention; see https://nathan-at-least.github.io/auto-deploy-howto.html +# When there is more than one [output.*] section, the HTML will be generated under `html/`. +# So, we set build-dir to the root directory of the repo and have a symlink from `docs/` to `html/`. +# GitHub pages only renders content under `docs/`; see https://nathan-at-least.github.io/auto-deploy-howto.html build-dir = "." [output.html]