Build-Documentation.yml

# *************************************************************************
# **  Copyright (c) 2024 CentraleSupélec & EDF.
# **  All rights reserved. This program and the accompanying materials
# **  are made available under the terms of the Eclipse Public License v2.0
# **  which accompanies this distribution, and is available at
# **  https://www.eclipse.org/legal/epl-v20.html
# ** 
# **  This file is part of the RiseClipse tool
# **  
# **  Contributors:
# **      Computer Science Department, CentraleSupélec
# **      EDF R&D
# **  Contacts:
# **      dominique.marcadet@centralesupelec.fr
# **      aurelie.dehouck-neveu@edf.fr
# **  Web site:
# **      https://riseclipse.github.io
# *************************************************************************

name: Build launcher documentation, deploy it on riseclipse.github.io

on: workflow_dispatch

jobs:
  docs:
    runs-on: ubuntu-22.04

    steps:
    - name: Checkout ${{ github.event.repository.name }}
      uses: actions/checkout@v4
      with:
        path: ${{ github.event.repository.name }}
        fetch-depth: 0

    - name: Checkout riseclipse-temporary
      uses: actions/checkout@v4
      with:
        repository: riseclipse/riseclipse-temporary
        path: riseclipse-temporary
        ref: master

    - name: Install Python
      uses: actions/setup-python@v5
      with:
        python-version: '3.12'
      
    - name: Install dependencies
      run: |
        pip install sphinx sphinx_rtd_theme pandas
        
    - name: Sphinx build
      run: |
        cd ${{ github.event.repository.name }}/fr.centralesupelec.edf.riseclipse.python.launcher/docs
        make html

    - name: Copy on riseclipse.github.io
      run: |
        cp -r ${{ github.event.repository.name }}/fr.centralesupelec.edf.riseclipse.python.launcher/docs/_build/html riseclipse-temporary/python-launcher-docs/

    - name: Configure Git User
      run: |
        cd riseclipse-temporary
        git config user.email github-actions@github.com
        git config user.name "GitHub Actions"

    - name: Commit and push to GitHub
      run: |
        git add --all
        git commit -m "New version of documentation of python-launcher"
        git push