From 26ad180d8153c3974ab20baa3444441fcd12a9ca Mon Sep 17 00:00:00 2001 From: VirtualTam Date: Sun, 1 Dec 2024 23:41:06 +0100 Subject: [PATCH] docs: update generated HTML location (required after enabling linkcheck) Signed-off-by: VirtualTam --- .github/workflows/docs.yaml | 2 +- Makefile | 4 ++-- docs/book.toml | 2 ++ docs/src/developer-guide/how-to/generating-documentation.md | 4 ++-- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index b6cec2a..cd17e81 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -35,7 +35,7 @@ jobs: id: deployment uses: actions/upload-pages-artifact@v3 with: - path: "./docs/book" + path: "./docs/book/html" publish: if: github.ref == 'refs/heads/main' diff --git a/Makefile b/Makefile index 15b180a..1d73419 100644 --- a/Makefile +++ b/Makefile @@ -105,10 +105,10 @@ dev-admin: DOCS_DIR := docs DOCS_FILES := $(shell find docs -name "*.md" -or -name "*.toml") -docs: docs/book +docs: docs/book/html .PHONY: docs -docs/book: $(DOCS_FILES) +docs/book/html: $(DOCS_FILES) mdbook build $(DOCS_DIR) live-docs: diff --git a/docs/book.toml b/docs/book.toml index 68bd2f1..5a77a0e 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -8,6 +8,8 @@ title = "SparkleMuffin: Documentation" [build] create-missing = false +[output.html] + [output.linkcheck] # https://github.com/Michael-F-Bryan/mdbook-linkcheck diff --git a/docs/src/developer-guide/how-to/generating-documentation.md b/docs/src/developer-guide/how-to/generating-documentation.md index ea673e4..d1c72ec 100644 --- a/docs/src/developer-guide/how-to/generating-documentation.md +++ b/docs/src/developer-guide/how-to/generating-documentation.md @@ -14,7 +14,7 @@ mdbook build docs 2023-11-05 16:19:04 [INFO] (mdbook::book): Running the html backend ``` -The generated website will be located under `docs/book`. +The generated website will be located under `docs/book/html`. ## Live-reload server @@ -32,7 +32,7 @@ mdbook serve docs 2023-11-05 16:19:25 [INFO] (warp::server): listening on http://[::1]:3000 ``` -- The generated website will be located under `docs/book`; +- The generated website will be located under `docs/book/html`; - The live server can be accessed by opening [http://localhost:3000](http://localhost:3000) in a Web browser. ## Reference