Skip to content

Commit 09bc137

Browse files
committed
chore: update documentation output directory to 'docs-gen' and adjust related configurations
1 parent c377d9d commit 09bc137

File tree

4 files changed

+7
-5
lines changed

4 files changed

+7
-5
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ jobs:
5858
if: github.event_name == 'push'
5959
uses: nwtgck/actions-netlify@4cbaf4c08f1a7bfa537d6113472ef4424e4eb654
6060
with:
61-
publish-dir: "./docs"
61+
publish-dir: "./docs-gen"
6262
production-branch: master
6363
github-token: ${{ secrets.GITHUB_TOKEN }}
6464
deploy-message: "${{ steps.deployment-type.outputs.message }}"
@@ -71,7 +71,7 @@ jobs:
7171
if: github.event_name == 'pull_request'
7272
uses: nwtgck/actions-netlify@4cbaf4c08f1a7bfa537d6113472ef4424e4eb654 # v3.0
7373
with:
74-
publish-dir: "./docs"
74+
publish-dir: "./docs-gen"
7575
production-branch: master
7676
github-token: ${{ secrets.GITHUB_TOKEN }}
7777
deploy-message: "${{ steps.deployment-type.outputs.message }}"

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ android/generated
8888
.env
8989
.xcode.env.local
9090
coverage/
91-
docs/
9291

9392
# Local Netlify folder
9493
.netlify
94+
95+
# Documentation
96+
docs-gen/

netlify.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[build]
22
# This is the directory that will be deployed to Netlify
3-
publish = "docs"
3+
publish = "docs-gen"
44

55
# Build command (not needed since we build in GitHub Actions)
66
command = "yarn docs"

typedoc.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
const config = {
44
entryPoints: ['./src/index.tsx'],
55
projectDocuments: ['README.md', 'most-used-modules.md'],
6-
out: './docs',
6+
out: './docs-gen',
77
tsconfig: './tsconfig.json',
88
excludeInternal: true,
99
excludePrivate: true,

0 commit comments

Comments
 (0)