From ed952f8d3c1f60afe211bf3ec08f2fbcb3bd1266 Mon Sep 17 00:00:00 2001 From: Alan Plum Date: Mon, 6 Jan 2025 14:50:05 +0100 Subject: [PATCH] Try to fix docs file links --- .github/workflows/docs.yml | 4 ++-- typedoc.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8db544bf7..722072684 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -71,13 +71,13 @@ jobs: - name: Rebuild docs for tag if: env.VERSION != 'devel' run: | - ./node_modules/.bin/typedoc --includeVersion --gitRevision ${{ github.ref_name }} --out gh-pages/${VERSION} + ./node_modules/.bin/typedoc --gitRevision ${{ github.ref_name }} --out gh-pages/${VERSION} --sourceLinkTemplate https://github.com/${{ github.repository }}/blob/${{ github.ref_name }}/src/{path}:{line} node -p 'var all=fs.readdirSync("gh-pages",{withFileTypes:true}).flatMap(f=>f.isDirectory()&&!isNaN(f.name.charAt(0))?[f.name]:[]).sort(require("semver").rcompare);JSON.stringify({all,stable:all.filter(s=>!s.includes("-"))})' > gh-pages/_data/versions.json - name: Rebuild docs for devel if: env.VERSION == 'devel' run: | - ./node_modules/.bin/typedoc --gitRevision ${{ github.sha }} --out gh-pages/${VERSION} + ./node_modules/.bin/typedoc --gitRevision ${{ github.sha }} --out gh-pages/${VERSION} --sourceLinkTemplate https://github.com/${{ github.repository }}/blob/${{ github.sha }}/src/{path}:{line} - name: Commit to gh-pages uses: EndBug/add-and-commit@v9 diff --git a/typedoc.json b/typedoc.json index 8b61f5458..d303ec223 100644 --- a/typedoc.json +++ b/typedoc.json @@ -11,7 +11,7 @@ "excludeInternal": true, "excludeProtected": true, "excludePrivate": true, - "includeVersion": false, + "includeVersion": true, "entryPoints": ["src"], "entryPointStrategy": "expand", "validation": {