Skip to content

Build user documentation pages (for manual run) #1

Build user documentation pages (for manual run)

Build user documentation pages (for manual run) #1

# This action is triggered whenever push to the docs folder of the master branch is made.
# It generates HTML pages from the docs folder of the master branch and push them to the gh-pages branch.
name: Build user documentation pages (test)
on:
workflow_dispatch
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Install Sphinx
run: pip install -U Sphinx==7.3.7
- name: Install Theme
run: pip install sphinx-rtd-theme
- name: Checkout master
uses: actions/checkout@master
with:
path: 'master'
- name: Checkout gh-pages
uses: actions/checkout@master
with:
path: 'gh_pages'
ref: 'gh-pages'
- name: Build user documentation
run: sphinx-build -b html "${GITHUB_WORKSPACE}/master/docs" "${GITHUB_WORKSPACE}/gh_pages/docs"
- name: Push changes in gh-pages
run: |
cd "${GITHUB_WORKSPACE}/gh_pages"
date > generated.txt
git config user.name github-actions
git config user.email [email protected]
git add .
git commit -m "update user documentation bot"
git push