Updated gem-elecrtric-motor with gem-control docs #280
This file contains hidden or 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
| name: Build | |
| on: | |
| workflow_dispatch: # Allows you to run this workflow manually from the Actions tab | |
| push: | |
| branches: [ master, nightly ] | |
| pull_request: | |
| branches: [ master, nightly ] | |
| jobs: | |
| test-code: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: [3.9, "3.10", "3.11", "3.12", "3.13"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| if [ -f requirements.txt ]; then pip install -r requirements.txt --prefer-binary; fi | |
| python -m pip install . | |
| - name: Test with pytest | |
| env: | |
| PY_VER: ${{ matrix.python-version }} | |
| run: | | |
| pytest | |
| build-doc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Build Sphinx documentation | |
| uses: nicholasphair/sphinx-action@7.0.0 | |
| with: | |
| pre-build-command: apt-get update && apt-get install -y git python3-tk tk8.6 tcl8.6 && python -m pip install myst-parser ipython python -m pip install --upgrade pip && python -m pip install sphinx m2r2 sphinx_rtd_theme==1.3.0 && python -m pip install -r requirements.txt && python -m pip install git+https://github.com/upb-lea/gem-control@main && python -m pip install git+https://github.com/upb-lea/control-block-diagram && python -m pip install . | |
| # Publish built docs to gh-pages branch. | |
| # =============================== | |
| # Publish built docs to gh-pages branch. | |
| # =============================== | |
| - name: Commit documentation changes | |
| run: | | |
| git clone https://github.com/upb-lea/gym-electric-motor.git --branch gh-pages --single-branch gh-pages | |
| cp -r docs/_build/html/* gh-pages/ | |
| cd gh-pages | |
| touch .nojekyll | |
| git config --local user.email "action@github.com" | |
| 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: Push changes | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| # =============================== |