Skip to content

Update README.md

Update README.md #25

Workflow file for this run

name: docs
on:
push:
branches:
- main
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install Rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
components: rustfmt
default: true
- name: Intall Python
uses: actions/setup-python@v5
with:
python-version: 3.7
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
sudo apt-get update
sudo apt-get install -y libkrb5-dev libclang-dev
- name: Build the book
run: |
jupyter-book build docs
- name: Build Rust Docs
uses: actions-rs/cargo@v1
with:
command: doc
args: --no-deps --features all
- name: Move the rust doc into jupyter book
run: mv target/doc ./docs/_build/html/rust-docs
- name: Add .nojekyll
run: touch ./docs/_build/html/.nojekyll
- name: Deploy Docs 🚀
uses: JamesIves/[email protected]
with:
branch: gh-pages # The branch the action should deploy to.
folder: ./docs/_build/html # The folder the action should deploy.
clean-exclude: dev
contrib-readme:
runs-on: ubuntu-latest
name: A job to automate contrib in readme
steps:
- name: Contribute List
uses: akhilmhdh/[email protected]
with:
image_size: 66
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}