Update README.md #303
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: Build Documentation website | |
on: | |
push: | |
branches: [master] | |
permissions: | |
contents: write | |
jobs: | |
docs: | |
name: Generate Website | |
runs-on: ubuntu-latest | |
env: | |
SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.11' | |
- name: Install dependencies | |
run: pip install -r docs/requirements.txt | |
- name: Install PettingZoo | |
run: pip install .[all] | |
- name: Generate environment docs | |
run: python docs/_scripts/gen_envs_mds.py | |
- name: Generate environments display | |
run: python docs/_scripts/gen_envs_display.py | |
- name: Build | |
run: sphinx-build -b dirhtml -v docs _build | |
- name: Move 404 | |
run: mv _build/404/index.html _build/404.html | |
- name: Update 404 links | |
run: python docs/_scripts/move_404.py _build/404.html | |
- name: Remove .doctrees | |
run: rm -r _build/.doctrees | |
- name: Upload to GitHub Pages | |
uses: JamesIves/github-pages-deploy-action@v4 | |
with: | |
folder: _build | |
target-folder: main | |
clean: false |