Skip to content

Build documentation with PasDoc and deploy to GitHub Pages #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 17, 2022
Merged

Build documentation with PasDoc and deploy to GitHub Pages #94

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5f65d4
Add CI workflow to build docs & deploy to GHPages
suve Nov 16, 2022
fbb52c7
Build docs on Ubuntu 22.04 instead of 20.04
suve Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build and deploy documentation

on:
push:
branches: ["master"]

workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-22.04
steps:
- name: Install PasDoc
run: |
export DEBIAN_FRONTEND=noninteractive
sudo apt update
sudo apt install -y pasdoc
- name: Checkout
uses: actions/checkout@v3
- name: Build documentation
run: |
mkdir gh-pages/
pasdoc --output gh-pages/ --format html --ignore-leading '*' --sort constants,functions,types,structures --define FPC --include units/ units/*.pas
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: 'gh-pages/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1