feat: Initial version #1
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: | |
| - dev | |
| paths-ignore: | |
| - "**.md" | |
| - LICENSE | |
| - .github/FUNDING.yml | |
| - .gitignore | |
| jobs: | |
| rustdoc: | |
| runs-on: ubuntu-latest | |
| env: | |
| # RUSTFLAGS: -D warnings | |
| CARGO_INCREMENTAL: 0 | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: nightly | |
| components: rust-src | |
| - name: Cache cargo output | |
| uses: Swatinem/rust-cache@v2 | |
| - name: Build Rust Documentation | |
| env: | |
| RUSTDOCFLAGS: --cfg _doc | |
| run: cargo doc -Zrustdoc-map | |
| - name: Build C Documentation | |
| uses: mattnotmitt/[email protected] | |
| - name: Deploy Docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: gh-pages | |
| publish_dir: ./target/doc | |
| force_orphan: true | |
| - name: Deploy External Docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} | |
| external_repository: oxilibc/oxilibc-docs | |
| publish_branch: main # default: gh-pages | |
| publish_dir: ./target/doc |