Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Build and host documentation
on:
push:
branches:
- master

jobs:
build:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Install Protoc
uses: arduino/setup-protoc@v1
- name: Checkout
uses: actions/checkout@v3
- 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"
RUSTFLAGS: "--cfg docsrs"
Comment thread
umgefahren marked this conversation as resolved.
- 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/upload-pages-artifact@v1.0.4
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@v1