mirror of
https://github.com/ostreedev/ostree.git
synced 2024-10-27 01:55:35 +03:00
9b6a8171c5
Make a copy of `man/html` to `docs/man` and then configure Jekyll to include it verbatim like the API docs. A link is added to the main index and the necessary commands are added to the github docs workflow.
46 lines
1.3 KiB
YAML
46 lines
1.3 KiB
YAML
---
|
|
name: Docs
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
permissions:
|
|
# This workflow pushes to the gh-pages branch, so the token needs write
|
|
# privileges for repo contents.
|
|
contents: write
|
|
|
|
jobs:
|
|
docs:
|
|
name: Build documentation
|
|
runs-on: ubuntu-latest
|
|
container: registry.ci.openshift.org/coreos/fcos-buildroot:testing-devel
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v2
|
|
|
|
# This is taken from ci/travis-install.sh but should probably be
|
|
# refactored.
|
|
- name: Install dependencies
|
|
run: ./ci/installdeps.sh
|
|
|
|
- name: Build API docs and manpages
|
|
run: |
|
|
./autogen.sh --enable-gtk-doc --enable-man --enable-man-html
|
|
make -C apidoc
|
|
make manhtml
|
|
|
|
- name: Build and publish jekyll docs
|
|
uses: helaili/jekyll-action@v2
|
|
with:
|
|
token: ${{ secrets.GITHUB_TOKEN }}
|
|
jekyll_src: docs
|
|
target_branch: gh-pages
|
|
# Only publish when pushing to main.
|
|
# XXX: Maybe this should only run on the release event?
|
|
build_only: ${{ github.ref == 'refs/heads/main' && 'false' || 'true' }}
|
|
# Run the prep script to put the API docs in place.
|
|
pre_build_commands: ./docs/prep-docs.sh
|