Build launcher documentation, deploy it on branch gh-pages #15
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # ************************************************************************* | |
| # ** 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: | |
| # ** [email protected] | |
| # ** [email protected] | |
| # ** Web site: | |
| # ** https://riseclipse.github.io | |
| # ************************************************************************* | |
| name: Build launcher documentation, deploy it on branch gh-pages | |
| on: workflow_dispatch | |
| jobs: | |
| build-python-launcher-docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - name: Checkout ${{ github.event.repository.name }} | |
| uses: actions/checkout@v4 | |
| with: | |
| path: ${{ github.event.repository.name }} | |
| - name: Checkout riseclipse.github.io | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: riseclipse/riseclipse.github.io | |
| path: riseclipse.github.io | |
| 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: Deploy on branch gh-pages | |
| uses: peaceiris/actions-gh-pages@v4 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: '${{ github.event.repository.name }}/fr.centralesupelec.edf.riseclipse.python.launcher/docs/_build/html' | |
| destination_dir: python-launcher-docs | |
| force_orphan: true | |
| commit_message: 'Update riseclipse-python-launcher-docs' |