Update documentation structure #12
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
| name: Check commit | |
| on: | |
| push: | |
| branches: ["main"] | |
| permissions: | |
| contents: write | |
| id-token: write | |
| pages: write | |
| jobs: | |
| unittest: | |
| name: Test on Python ${{ matrix.python-version }} | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: ["3.8", "3.9", "3.10"] | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pyopengl==3.1.6 | |
| pip install .[test] | |
| - name: Test with pytest | |
| run: | | |
| pytest ./tests/ | |
| coverage: | |
| name: Upload coverage report | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install pyopengl==3.1.6 | |
| pip install .[test] | |
| - name: Produce coverage report | |
| run: | | |
| pytest --cov dm_robotics.panda --cov-report xml:coverage.xml ./tests/ | |
| - name: Upload coverage report to Codecov | |
| uses: codecov/codecov-action@v3 | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| linting: | |
| name: Linting | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[lint] | |
| - name: Lint with pylint | |
| run: | | |
| mkdir ./pylint | |
| pylint --rcfile .pylintrc --output-format=text --exit-zero src/ | tee ./pylint/pylint.log | |
| PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' ./pylint/pylint.log) | |
| anybadge --label=Pylint --file=pylint/pylint.svg --value=$PYLINT_SCORE 2=red 4=orange 8=yellow 10=green | |
| - name: Upload linting artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: linting | |
| path: ./pylint | |
| documentation: | |
| name: Build documentation | |
| runs-on: ubuntu-latest | |
| needs: unittest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.10 | |
| uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.10" | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[doc] | |
| - name: Build with Sphinx | |
| run: cd doc && make html | |
| - name: Upload documentation artifact | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: documentation | |
| path: ./doc/_build/html | |
| upload: | |
| name: Upload to GitHub pages | |
| runs-on: ubuntu-latest | |
| needs: [documentation, linting] | |
| steps: | |
| - name: Download documentation artifact | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: documentation | |
| path: ./html | |
| - name: Download linting artifact | |
| uses: actions/download-artifact@v3 | |
| with: | |
| name: linting | |
| path: ./html | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| path: ./html | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 | |