Skip to content

Commit

Permalink
Add documentation GitHub action workflow.
Browse files Browse the repository at this point in the history
  • Loading branch information
ebertin committed Mar 9, 2023
1 parent 99c3353 commit 78282aa
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 1 deletion.
51 changes: 51 additions & 0 deletions .github/workflows/doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
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 }}


2 changes: 1 addition & 1 deletion doc/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
# There are two options for replacing |today|: either, you set today to some
# 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.
#
Expand Down

0 comments on commit 78282aa

Please sign in to comment.