Skip to content

document more

document more #4

Workflow file for this run

name: Rust
on:
push:
branches: [334-publish-rustdoc-on-github-pages]
pull_request:
branches: [334-publish-rustdoc-on-github-pages]
env:
CARGO_TERM_COLOR: always
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
jobs:
rustdoc:
if: ( ! github.event.pull_request.draft )
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Rust Toolchain (Stable)
uses: dtolnay/rust-toolchain@stable
with:
toolchain: stable
- name: "rustdoc"
run: cd tlsn; cargo doc --all --examples
# --target-dir ${GITHUB_WORKSPACE}/docs
# https://dev.to/deciduously/prepare-your-rust-api-docs-for-github-pages-2n5i
- name: "publish"
run: |
echo "<meta http-equiv=\"refresh\" content=\"0; url=tlsn_core\">" > tlsn/target/doc/index.html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/334-publish-rustdoc-on-github-pages' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: tlsn/target/doc/
# cname: rustdocs.tlsnotary.org