fix: resolve MyST build warnings #245
Workflow file for this run
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
| name: MyST Book | |
| # Controls when the workflow will run | |
| on: | |
| # Triggers the workflow on push or pull request events but only for the "main" branch | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # This workflow contains a single job called "build" | |
| build: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| # To prevent github actions from eating up too many enterprise minutes | |
| timeout-minutes: 5 | |
| # https://github.com/actions/starter-workflows/blob/55eb18560f57898549b12afa6defe7cc79705d6a/pages/static.yml#L13 | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| # Checks out your repository under $GITHUB_WORKSPACE, so your job can access it | |
| - uses: actions/checkout@v4 | |
| # Convert basic_lessons/*.md → basic_lessons/*.ipynb so the site provides "Download notebook" buttons | |
| # https://jupytext.readthedocs.io/ — supports md:myst format natively | |
| # Must run BEFORE build so myst/jupyter-book can pick up the generated notebooks | |
| - name: Generate downloadable notebooks | |
| run: | | |
| pip install jupytext | |
| for f in basic_lessons/lesson*_tutorial.md basic_lessons/lesson*_exercise_answers.md; do | |
| [ -f "$f" ] || continue | |
| out="${f%.md}.ipynb" | |
| python -m jupytext --from md:myst --to notebook --output "$out" "$f" | |
| echo "Generated: $out" | |
| done | |
| # Runs a set of commands using the runner's shell | |
| # https://mystmd.org/guide/deployment-github-pages#fn-except-custom-domains | |
| - name: Install dependencies and build page | |
| run: | | |
| chmod +x build_html.sh | |
| ./build_html.sh | |
| # https://jupyterbook.org/en/stable/publish/gh-pages.html | |
| # Upload the book's HTML as an artifact | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "_build/html" | |
| # https://github.com/actions/deploy-pages/issues/305 | |
| - name: Configure Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |