Skip to content

Generate documentation automatically #8

Generate documentation automatically

Generate documentation automatically #8

Workflow file for this run

# Automatic generation of documentation will be copied and checked into the
# gh-pages branch.
name: Documentation generation CI
on:
push:
branches-ignore:
- 'gh-pages'
tags: []
pull_request:
branches-ignore:
- 'gh-pages'
jobs:
build:
runs-on: ubuntu-latest
steps:
# checkout branch
- uses: actions/checkout@v3
# Install dblatex
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install -y dblatex
# generate the documentation files
- name: Generate PDF documentation
run: |
cd doc
dblatex -s texstyle.sty mobilitydb-workshop.xml
# store the documentation files
- name: Upload Output Directory
uses: actions/upload-artifact@v2
with:
name: doc-files
path: doc
retention-days: 1
copy:
name: Build
runs-on: ubuntu-latest
needs: build
steps:
# checkout the gh-pages branch
- uses: actions/checkout@v3
with:
ref: gh-pages
# download the doc files, most of which are generated above
- name: Download Output Directory
uses: actions/download-artifact@v2
with:
name: doc-files
path: doc
# add, commit and push to gh-pages
- name: Commit changes
uses: EndBug/add-and-commit@v7
with:
message: 'Update docs'
branch: gh-pages
add: '["doc/mobilitydb-workshop.pdf"]'