doc(whl): polish doc for loss, compression helper and bfs helper. (#747) #1208
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 check flake style | |
| # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
| name: doc | |
| on: | |
| push: | |
| branches: [main, '*doc*'] | |
| jobs: | |
| doc: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| python-version: [3.8] | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python ${{ matrix.python-version }} | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| - name: Generate | |
| run: | | |
| python -m pip install . | |
| git clone -b main https://github.com/opendilab/DI-engine-docs.git | |
| cd DI-engine-docs | |
| python -m pip install -r requirements.txt | |
| make html | |
| mv build/html ../public | |
| rm -rf build | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@3.7.1 | |
| with: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| BRANCH: gh-pages # The branch the action should deploy to. | |
| FOLDER: public # The folder the action should deploy. | |
| CLEAN: true # Automatically remove deleted files from the deploy branch |