Skip to content

Update README.md

Update README.md #6

Workflow file for this run

# documentation.yml
# Copyright 9bit Embedded (Quantash project).
# Licensed under the Apache License, Version 2.0, see LICENSE for details.
# SPDX-License-Identifier: Apache-2.0
name: Deploy Documenttaion
on:
push:
branches:
- main
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
# Step 1: Clone repository
- name: Checkout Repository
uses: actions/checkout@v4
# Step 2: Python Setup
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x
# Step 3: Install dependencies
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r python_requirements.txt
# Step 4: Build MkDoc
- name: Build MkDocs Site
run: mkdocs build
# Step 5: Setup GitHub Pages
- name: Setup Pages
uses: actions/configure-pages@v5
# Step 6: Upload Artifact generated by MkDocs
- name: Upload Artifact
uses: actions/upload-pages-artifact@v3
with:
path: './site'
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4