[conf.py] Updated announcement message. #42
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 is a basic workflow to help you get started with Actions | |
| name: sphinx docs with myst | |
| # 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 | |
| # 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 | |
| with: | |
| fetch-depth: 0 | |
| # Runs a set of commands using the runner's shell | |
| # https://mystmd.org/guide/deployment-github-pages#fn-except-custom-domains | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y ffmpeg | |
| pip install . | |
| - name: Generate gallery assets | |
| run: | | |
| cd docs | |
| dqrobotics_pyplot_output_doc_samples | |
| cd .. | |
| - name: Build page | |
| run: | | |
| cd docs | |
| pip install -r requirements.txt | |
| make html | |
| cd .. | |
| # 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: "docs/_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 |