Merge pull request #158 from NREL/f2/readme-logo #43
This file contains 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: Deploy mdBook site to Pages | |
| on: | |
| # Runs on pushes targeting the default branch | |
| push: | |
| branches: ["fastsim-2"] | |
| paths: | |
| - "docs/**" | |
| - ".github/workflows/deploy-book.yaml" | |
| - "README.md" | |
| - "python/**" | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| # 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: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| env: | |
| MDBOOK_VERSION: 0.4.21 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install mdBook and supporting dependencies | |
| run: | | |
| curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh | |
| rustup update | |
| cargo install --version ${MDBOOK_VERSION} mdbook | |
| - name: Install dependencies for python docs | |
| run: | |
| sudo apt update && | |
| sudo apt install pipx && | |
| pipx ensurepath && | |
| pipx install pydoc-markdown | |
| - name: Generate python docs | |
| working-directory: ${{runner.workspace}}/fastsim/ | |
| run: | |
| pydoc-markdown -I python/ --render-toc > docs/src/python-doc.md | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@v3 | |
| - name: Build with mdBook | |
| working-directory: ${{runner.workspace}}/fastsim/docs/ | |
| run: mdbook build | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v1 | |
| with: | |
| path: ./docs/book | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |