Try to fix docs file links

arangodb · Jan 6, 2025 · ed952f8 · ed952f8
1 parent 737bd68
commit ed952f8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git 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
@@ -11,7 +11,7 @@
   "excludeInternal": true,
   "excludeProtected": true,
   "excludePrivate": true,
-  "includeVersion": false,
+  "includeVersion": true,
   "entryPoints": ["src"],
   "entryPointStrategy": "expand",
   "validation": {