chore: fix some comments (#5661) #1451
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: Build and host documentation | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
build: | |
name: Build documentation | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
- name: Install nightly toolchain | |
run: rustup toolchain install nightly | |
- name: Build Documentation | |
run: cargo +nightly doc --no-deps --workspace -F full | |
env: | |
RUSTDOCFLAGS: "--cfg docsrs" | |
- name: Add index file | |
run: | | |
mkdir host-docs | |
echo "<meta http-equiv=\"refresh\" content=\"0; url=libp2p\">" > target/doc/index.html | |
cp -r target/doc/* ./host-docs | |
- name: Upload documentation | |
uses: actions/[email protected] | |
with: | |
path: "host-docs/" | |
deploy: | |
name: Deploy documentation | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 | |