small edit in writing #67
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
| # This file was created automatically with `myst init --gh-pages` 🪄 💚 | |
| # Ensure your GitHub Pages settings for this repository are set to deploy with **GitHub Actions**. | |
| name: MyST GitHub Pages Deploy | |
| on: | |
| push: | |
| # Runs on pushes targeting the default branch | |
| branches: [main] | |
| env: | |
| # `BASE_URL` determines, relative to the root of the domain, the URL that your site is served from. | |
| # E.g., if your site lives at `https://mydomain.org/myproject`, set `BASE_URL=/myproject`. | |
| # If, instead, your site lives at the root of the domain, at `https://mydomain.org`, set `BASE_URL=''`. | |
| BASE_URL: /${{ github.event.repository.name }} | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: 'pages' | |
| cancel-in-progress: false | |
| jobs: | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| #https://github.com/actions/setup-python?tab=readme-ov-file#caching-packages-dependencies | |
| python-version: '3.11' # or your version | |
| # cache: 'pip' # | |
| - name: Install Python dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| # If you have a requirements file, prefer that: | |
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | |
| # Minimum needed for execution: | |
| pip install jupyter-server nbclient nbformat ipykernel jupyter-client ipython | |
| # Common plotting libs (adjust to your stack): | |
| pip install matplotlib numpy pandas scipy plotly | |
| # If you use plotly static images: | |
| # pip install plotly kaleido | |
| # Make sure a kernel is visible: | |
| python -m ipykernel install --user --name=python3 | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: 18.x | |
| - name: Install MyST | |
| run: npm install -g mystmd | |
| - name: Build HTML Assets | |
| run: myst build --execute --html | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: './_build/html' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |