Merge pull request #299 from jupyter/doc/jupyter-book-2 #123
This file contains hidden or 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
| # Deploy the live documentation to our GitHub Pages site | |
| name: deploy | |
| # Only run this when the master branch changes | |
| on: | |
| push: | |
| branches: | |
| - main | |
| # This job installs dependencies, builds the book, and pushes it to `gh-pages` | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| # So that we can write to `gh-pages` | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Install dependencies | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/cache@v4 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/*.md') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: | | |
| pip install -r requirements.txt | |
| # Build the site | |
| - name: Build the MyST site | |
| env: | |
| BASE_URL: /${{ github.event.repository.name }} | |
| run: | | |
| cd docs && myst build --html | |
| # Generate redirects from old URLs to new URLs | |
| - name: Generate redirects | |
| run: | | |
| python scripts/generate_redirects.py "https://jupyter.org/governance/" "docs/_build/redirects" | |
| # Copy redirects into the build directory | |
| - name: Merge redirects into build | |
| run: | | |
| cp -r docs/_build/redirects/* docs/_build/html/ | |
| # Push the book's HTML to github-pages | |
| - name: GitHub Pages action | |
| uses: peaceiris/[email protected] | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html |