Added documentation to retrans_buffer and changed RDMA_sw for easier debugging #10
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
# A work-flow for generating documentation given a PR | |
# Builds Sphinx documentation, uploads the generated HTML files as artefacts and deploys them to GitHub Pages | |
name: Build docs | |
# It runs on every pull request, but it only generates the documentation from master (which makes sense) | |
on: | |
pull_request: | |
branches: | |
- master | |
jobs: | |
sphinx-build: | |
# Target platform; mostly doesn't matter for HTML websites generated from Sphinx | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
# 1) Build HTML from Sphinx | |
- name: Build HTML | |
uses: ammaraskar/[email protected] | |
with: | |
pre-build-command: "apt install -y pandoc" | |
# 2) Upload the generated HTML | |
- name: Upload artifacts | |
uses: actions/upload-artifact@v3 | |
with: | |
name: html-docs | |
path: docs/build/html/ | |
# 3) Deploy using GitHub pages, but only if the branch == master | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
if: github.ref == 'refs/heads/master' | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/build/html |