Generate API Reference documentation using typedocs and gh-actions

Signed-off-by: Mario Sarcher <msarcher@mirantis.com>
This commit is contained in:
Mario Sarcher committed 2020-11-10 09:36:28 +01:00
1 parent b7fde0c6a6
commit de85229512
6 files changed
+69 -10

No files matched your search

+16 -2
View File
@@ -8,6 +8,9 @@ jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [12.x]
steps:
- name: Set up Python 3.7
uses: actions/setup-python@v2
@@ -31,8 +34,19 @@ jobs:
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git pull
- name: Using Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v1
with:
node-version: ${{ matrix.node-version }}
- name: Generate Extensions API Reference using typedocs
run: |
yarn install
yarn typedocs-extensions-api
for filename in docs/extensions/api/**/*.md; do [ -e "$filename" ] || continue; sed -i '1s/^/---\ntitle: API Reference\n---\n/' $filename; done
- name: mkdocs deploy latest
run: |
mike deploy --push latest