Skip to content

Convert style guide from markdown to rst #26

Convert style guide from markdown to rst

Convert style guide from markdown to rst #26

Workflow file for this run

name: "Documentation Build"
concurrency:
group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }}
cancel-in-progress: true
on:
- pull_request
- release
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[doc]
- name: Build documentation
run: |
make -C docs html
- uses: actions/upload-artifact@v2
with:
name: DocumentationHTML
path: docs/build/html/
# Publish built docs to gh-pages branch
- name: Commit documentation changes
# push docs only when a GitHub Release is made
if: github.event_name == 'release' && github.event.action == 'published'
run: |
git clone https://github.com/IMAP-Science-Operations-Center/imap_processing.git --branch gh-pages --single-branch gh-pages
cp -r docs/build/html/* gh-pages/
cd gh-pages
git config --local user.email "[email protected]"
git config --local user.name "GitHub Action"
git add .
git commit -m "Update documentation" -a || true
# The above command will fail if no changes were present, so we ignore that.
- name: Publish docs
# push docs only when a GitHub Release is made
if: github.event_name == 'release' && github.event.action == 'published'
uses: ad-m/github-push-action@master
with:
branch: gh-pages
directory: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}