adding topox to readme #165
Workflow file for this run
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: "Docs: Check and Deploy" | |
| on: | |
| push: | |
| branches: [main, github-actions-test] | |
| pull_request: | |
| branches: [main] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: write | |
| jobs: | |
| build: | |
| runs-on: ${{matrix.os}} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: [3.10.11] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build using Python ${{matrix.python-version}} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{matrix.python-version}} | |
| cache: "pip" | |
| cache-dependency-path: "pyproject.toml" | |
| - name: Install dependencies [pip] | |
| run: | | |
| pip install "karateclub @ git+https://github.com/benedekrozemberczki/karateclub@cb46a91df8dcbeb2570debcf6a9d0c518107a2de" | |
| pip install -e .[doc] | |
| - name: Install Pandoc [apt-get] | |
| run: | | |
| sudo apt-get -y install pandoc | |
| - name: Generate Docs [Sphinx] | |
| run: | | |
| sphinx-build -b html -D version=latest -D release=latest docs docs/_build | |
| - name: Deploy Docs | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && github.repository == 'pyt-team/TopoEmbedX' }} | |
| with: | |
| branch: main | |
| folder: docs/_build | |
| token: ${{ secrets.DOCUMENTATION_KEY }} | |
| repository-name: pyt-team/pyt-team.github.io | |
| target-folder: topoembedx | |
| clean: true | |
| numpydoc-validation: | |
| runs-on: ${{matrix.os}} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: [3.12] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Build using Python ${{matrix.python-version}} | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{matrix.python-version}} | |
| cache: "pip" | |
| cache-dependency-path: "pyproject.toml" | |
| - name: Install dependencies [pip] | |
| run: | | |
| pip install "karateclub @ git+https://github.com/benedekrozemberczki/karateclub@cb46a91df8dcbeb2570debcf6a9d0c518107a2de" | |
| pip install -e .[doc] | |
| - name: Checking NumpyDoc Validation for files | |
| run: | | |
| numpydoc lint test/**/*.py topoembedx/**/*.py |