From a5eb665b7d423426fe5e695e703ae2b49e1fc43c Mon Sep 17 00:00:00 2001 From: Leon Yee <43097991+unkn-wn@users.noreply.github.com> Date: Thu, 6 Jul 2023 21:10:36 -0700 Subject: [PATCH] [docs] dynamic docs generation and deployment (#253) Solves #245 , edited docs.yml to run the generation of docs before deployment. Tested on a test repository --- .github/workflows/docs.yml | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index a55e74fa..6d815eec 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -39,6 +39,28 @@ jobs: run: | python -m pip install -e . python -m pip install -r ../docs/requirements.txt + - name: Set up node + uses: actions/setup-node@v3 + with: + node-version: ${{ matrix.node-version }} + cache: 'npm' + cache-dependency-path: node/package-lock.json + - uses: Swatinem/rust-cache@v2 + - name: Install node dependencies + working-directory: node + run: | + sudo apt update + sudo apt install -y protobuf-compiler libssl-dev + - name: Build node + working-directory: node + run: | + npm ci + npm run build + npm run tsc + - name: Create markdown files + working-directory: node + run: | + npx typedoc --plugin typedoc-plugin-markdown --out ../docs/src/javascript src/index.ts - name: Build docs run: | PYTHONPATH=. mkdocs build -f docs/mkdocs.yml @@ -50,4 +72,4 @@ jobs: path: "docs/site" - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 + uses: actions/deploy-pages@v1 \ No newline at end of file