From 138e7bd0ecc62203b7bcc9c9e12c1dc1cbcfbebc Mon Sep 17 00:00:00 2001 From: Marc Rousavy Date: Thu, 4 Mar 2021 10:38:42 +0100 Subject: [PATCH] Ignore `example/` for building docs --- .github/workflows/build-docs.yml | 9 +-------- docs/docusaurus.config.js | 2 +- tsconfig.docs.json | 5 +++++ 3 files changed, 7 insertions(+), 9 deletions(-) create mode 100644 tsconfig.docs.json diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 6bc6388..500bd5d 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -40,13 +40,10 @@ jobs: key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} restore-keys: | ${{ runner.os }}-yarn- - - name: Install modules - run: yarn install --frozen-lockfile - - name: Install modules (example/) - run: yarn example --frozen-lockfile - name: Test Docs Build run: | + yarn install --frozen-lockfile cd docs yarn install --frozen-lockfile yarn build @@ -82,10 +79,6 @@ jobs: key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} restore-keys: | ${{ runner.os }}-yarn- - - name: Install modules - run: yarn install --frozen-lockfile - - name: Install modules (example/) - run: yarn example --frozen-lockfile - name: Release to GitHub Pages env: diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index cef8b7c..7a0b79e 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -97,7 +97,7 @@ module.exports = { { entryPoints: ['../src'], exclude: "../src/index.ts", - tsconfig: '../tsconfig.json', + tsconfig: '../tsconfig.docs.json', readme: "none", sidebar: { sidebarFile: 'typedoc-sidebar.js', diff --git a/tsconfig.docs.json b/tsconfig.docs.json new file mode 100644 index 0000000..999d3f3 --- /dev/null +++ b/tsconfig.docs.json @@ -0,0 +1,5 @@ + +{ + "extends": "./tsconfig", + "exclude": ["example"] +}