sphinx.yml

# This is a basic workflow to help you get started with Actions

name: Build-sphinx-docs

# Controls when the workflow will run
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ luca ]
  pull_request:
    branches: [ luca ]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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
    env:
      PYTHONPATH: $(pwd)/src # Define the environment variable here
    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v2

      - name: Set up Python 3.12
        uses: actions/setup-python@v2
        with:
          python-version: "3.12"

      # WORKFLOW FOR SPHINX WITH PIP
      # - name: Install dependencies
      #   run: | 
      #     python -m pip install --upgrade pip
      #     pip install sphinx nbsphinx myst_parser sphinx-copybutton sphinx_rtd_theme sphinx_rtd_size ghp-import pyomo
      # - name: Build HTML
      #   run: | 
      #     cd docs/
      #     make html
      # - name: Run ghp-import
      #   run: | 
      #     ghp-import -n -p -f docs/_build/html

      # WORKFLOW FOR SPHINX WITH POETRY
      - name: Install Poetry
        run: |
          curl -sSL https://install.python-poetry.org | python3 -
          export PATH="$HOME/.local/bin:$PATH"
          poetry --version
    
      - name: Install dependencies with Poetry
        run: |
          export PATH="$HOME/.local/bin:$PATH"
          poetry install
    
      - name: Build HTML
        run: |
          export PATH="$HOME/.local/bin:$PATH"
          poetry run sphinx-build -b html docs/ docs/_build/html
      
      - name: Run ghp-import
        run: |
          export PATH="$HOME/.local/bin:$PATH"
          poetry run ghp-import -n -p -f docs/_build/html


      # Runs a set of commands using the runners shell
      - name: Run a multi-line script
        run: |
          echo Add other actions to build,
          echo test, and deploy your project.