Skip to content

Commit

Permalink
Add automatic source doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
andrjohns committed Jul 2, 2024
1 parent 11a58b8 commit 317d6fc
Show file tree
Hide file tree
Showing 4 changed files with 205 additions and 555 deletions.
18 changes: 12 additions & 6 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,6 @@ name: Deploy Jekyll site to Pages
on:
push:
branches: ["main"]
paths:
- PowerBI-SPC-Docs/** # Push events to docs folder

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand All @@ -30,29 +28,37 @@ jobs:
# Build job
build:
runs-on: ubuntu-latest
defaults:
run:
working-directory: PowerBI-SPC-Docs/docs
steps:
- uses: actions/checkout@v4
with:
submodules: true

- uses: actions/setup-node@v4
- name: Install Dependencies
run: npm install

- name: Setup Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1' # Not needed with a .ruby-version file
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
cache-version: 0 # Increment this number if you need to re-download cached gems
working-directory: '${{ github.workspace }}/PowerBI-SPC-Docs/docs'

- name: Setup Pages
id: pages
uses: actions/configure-pages@v5
- name: Build with Jekyll

- name: Build Site Page with Jekyll
# Outputs to the './_site' directory by default
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
working-directory: '${{ github.workspace }}/PowerBI-SPC-Docs/docs'
env:
JEKYLL_ENV: production

- name: Build API doc
run: npx typedoc --out PowerBI-SPC-Docs/docs/_site/API

- name: Upload artifact
# Automatically uploads an artifact from the './_site' directory by default
uses: actions/upload-pages-artifact@v3
Expand Down
Loading

0 comments on commit 317d6fc

Please sign in to comment.