docs(book): complete missing docs for the MVP (#65) #24
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: Docs | |
| on: | |
| push: | |
| branches: [ main ] | |
| jobs: | |
| deploy: | |
| name: Deploy | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup mdBook | |
| uses: peaceiris/actions-mdbook@v1 | |
| with: | |
| mdbook-version: 'latest' | |
| - name: Build the book | |
| run: cd docs && mdbook build | |
| - name: Setup rust toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: Build rust docs | |
| run: | | |
| RUSTDOCFLAGS="--enable-index-page -Zunstable-options" cargo doc \ | |
| --workspace \ | |
| --no-deps \ | |
| --document-private-items | |
| - name: Assemble docs | |
| run: mv target/doc docs/book/rustdocs | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| # if: github.ref == 'refs/heads/main' | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/book |