Skip to content

Commit 0b54b4b

Browse files
committed
Use dirhtml builder for docs instead of html
This fixes canonical URLs ending in `/index.html` by generating directory-style URLs (`/`), which avoids the Google Search Console indexing warning: "Alternate page with proper canonical tag."
1 parent 32b18a0 commit 0b54b4b

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

.github/workflows/docs.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ jobs:
3232
3333
- name: Build docs
3434
working-directory: ./docs
35-
run: make html
35+
run: make dirhtml
3636

3737
- name: Upload docs artifact
3838
uses: actions/upload-artifact@v4
3939
with:
40-
name: docs-html
41-
path: ./docs/build/html
40+
name: docs-dirhtml
41+
path: ./docs/build/dirhtml
4242

4343
deploy_docs:
4444
runs-on: ubuntu-latest
@@ -47,11 +47,11 @@ jobs:
4747
- name: Download artifacts
4848
uses: actions/download-artifact@v4
4949
with:
50-
name: docs-html
51-
path: ./docs/build/html
50+
name: docs-dirhtml
51+
path: ./docs/build/dirhtml
5252

5353
- name: Deploy to gh-pages
5454
uses: peaceiris/actions-gh-pages@v4
5555
with:
5656
github_token: ${{ secrets.GITHUB_TOKEN }}
57-
publish_dir: ./docs/build/html
57+
publish_dir: ./docs/build/dirhtml

0 commit comments

Comments
 (0)