Skip to content

fix in Readme

fix in Readme #104

# This is a basic workflow to help you get started with Actions
name: build_docs
# Controls when the action will run.
on:
# Triggers the workflow on push or pull request events but only for the master branch
push:
branches: [ dev ]
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
# This workflow contains a single job called "build"
build:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
# get copy of the code
- uses: actions/checkout@v2
- name: install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_dev.txt
- name: make html & commit the changes
run: |
sphinx-build -b html ./docs_source ./docs
git config user.name "github actions"
git config --global user.email "[email protected]"
git config pull.rebase false
git add -f ./docs
git commit -m 'update docs'
git pull -s recursive -X ours origin gh-pages --allow-unrelated-histories
- name: push changes to gh-pages to show automatically
uses: ad-m/github-push-action@main
with:
branch: gh-pages
#force: true