build-docs-dev.yml 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. name: Build main branch documentation website
  2. on:
  3. push:
  4. branches: [master]
  5. permissions:
  6. contents: write
  7. jobs:
  8. docs:
  9. name: Generate Website
  10. runs-on: ubuntu-latest
  11. env:
  12. SPHINX_GITHUB_CHANGELOG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  13. steps:
  14. - uses: actions/checkout@v3
  15. - uses: actions/setup-python@v4
  16. with:
  17. python-version: '3.9'
  18. - name: Install dependencies
  19. run: pip install -r docs/requirements.txt
  20. - name: Register Envs
  21. run: pip install -e .
  22. - name: Build Envs Docs
  23. run: python docs/scripts/gen_mds.py
  24. - name: Build Envs Display
  25. run: python docs/scripts/gen_envs_display.py
  26. - name: Build
  27. run: sphinx-build -b dirhtml -v docs _build
  28. - name: Move 404
  29. run: mv _build/404/index.html _build/404.html
  30. - name: Update 404 links
  31. run: python docs/scripts/move_404.py _build/404.html
  32. - name: Remove .doctrees
  33. run: rm -r _build/.doctrees
  34. - name: Upload to GitHub Pages
  35. uses: JamesIves/github-pages-deploy-action@v4
  36. with:
  37. folder: _build
  38. target-folder: main
  39. clean: false