Commit 78282aac authored by Emmanuel Bertin's avatar Emmanuel Bertin
Browse files

Add documentation GitHub action workflow.

parent 99c3353a
name: doc
on:
push:
paths:
- 'doc/**'
pull_request:
paths:
- 'doc/**'
workflow_dispatch:
jobs:
#############
# Build doc #
#############
build:
name: Make HTML doc
continue-on-error: false
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Install dependencies
run: |
pip3 install -r doc/requirements.txt
- name: Build doc
run: |
./autogen.sh
./configure
cd doc
make html
- name: Set destination dir
if: github.ref_name != 'main'
run: |
echo "DOC_DEST=${{ github.ref_name }}" >> $GITHUB_ENV
- name: Deploy
if: success()
uses: peaceiris/actions-gh-pages@v3
with:
publish_branch: doc-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc/build/html/
destination_dir: ${{ env.DOC_DEST }}
...@@ -69,7 +69,7 @@ release = '2.28.0' ...@@ -69,7 +69,7 @@ release = '2.28.0'
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:
# #
today = 'Tue Mar 07 2023' today = 'Thu Mar 09 2023'
# #
# Else, today_fmt is used as the format for a strftime call. # Else, today_fmt is used as the format for a strftime call.
# #
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment