Enhance HTML rendering in ANSITable: improve docstring clarity and su… #42
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
| # This workflow will install Python dependencies, run tests and lint with a variety of Python versions | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: build | |
| on: | |
| push: | |
| branches: [ master ] | |
| # pull_request: | |
| # branches: [ master ] | |
| jobs: | |
| # Run tests on different versions of python | |
| unittest: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [windows-latest, ubuntu-latest, macos-12] | |
| python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install . | |
| pip install pytest | |
| pip install numpy | |
| pip install pandas | |
| - name: Test with pytest | |
| run: | | |
| pytest -s --ignore=W605 | |
| sphinx: | |
| # If the above worked: | |
| # Build docs and upload to GH Pages | |
| needs: unittest | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.7 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.7 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[docs] | |
| pip install git+https://github.com/petercorke/sphinx-autorun.git | |
| - name: Build docs | |
| run: | | |
| cd docs | |
| make html | |
| # Tell GitHub not to use jekyll to compile the docs | |
| touch build/html/.nojekyll | |
| cd ../ | |
| - name: Commit documentation changes | |
| run: | | |
| git clone https://github.com/petercorke/ansitable.git --branch gh-pages --single-branch gh-pages | |
| cp -r docs/build/html/* gh-pages/ | |
| cd gh-pages | |
| git config --local user.email "[email protected]" | |
| 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 }} |