Skip to content

Commit

Permalink
docs(contracts) - add script to setup website in one go (including ru…
Browse files Browse the repository at this point in the history
…nning typedoc, and solidity docgen) in order to allow preview via netlify
  • Loading branch information
ctrlc03 committed Dec 7, 2023
1 parent 418ed61 commit 9bd1e45
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 29 deletions.
15 changes: 15 additions & 0 deletions .github/scripts/website.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#!/bin/bash

set -e

# install and build project
npm install && npm run bootstrap && npm run build

# run typedoc
npm run typedoc

# run solidity docgen
cd contracts && npm run docs && cd ../

# fix typedoc links and add solidity natspec index toc
cd website && npm install && npm run build
31 changes: 2 additions & 29 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,36 +22,9 @@ jobs:
node-version: 20
registry-url: "https://registry.npmjs.org"

- name: Install dependencies and build project
- name: Build website
run: |
npm install
npm run bootstrap
npm run build
- name: Run typedoc
run: |
npm run typedoc
- name: Run Solidity Docgen
run: |
npm run docs
working-directory: contracts

- name: Install website dependencies
run: |
npm install
working-directory: website

- name: Fix typedoc and solidity docgen links
run: |
npm run setup-typedoc
npm run setup-soliditydocs
working-directory: website

- name: Build 🔧
run: |
npm run build
working-directory: website
./.github/scripts/website.sh
- name: Add CNAME
run: |
Expand Down

0 comments on commit 9bd1e45

Please sign in to comment.