Skip to content

Commit

Permalink
CI: add a job to build docs
Browse files Browse the repository at this point in the history
Would be useful for contributors or people planning to use libgir
  • Loading branch information
bilelmoussaoui committed Dec 11, 2022
1 parent ec44c24 commit 8a8fff5
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: docs

on:
pull_request:
push:
branches:
- "master"
workflow_dispatch:

jobs:
build-deploy:
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v3
- uses: actions-rs/toolchain@v1
with:
profile: minimal
toolchain: stable
override: true
- uses: actions-rs/cargo@v1
with:
command: doc
args: --no-deps

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./target/doc
keep_files: false
destination_dir: docs
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
## How to use

A work in progress book to help with learning how to use `gir` along with a tutorial are available at <https://gtk-rs.org/gir/book>.

If you intend to contribute to `gir` or make use of `libgir`, the docs are available at <https://gtk-rs.org/gir/docs/gir> / <https://gtk-rs.org/gir/docs/libgir>.

0 comments on commit 8a8fff5

Please sign in to comment.