Skip to content

DOC: add developer section to README #7

DOC: add developer section to README

DOC: add developer section to README #7

Workflow file for this run

name: Build and Deploy Sphinx Docs
on:
push:
branches:
- develop
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
lfs: true
- name: Checkout LFS objects
run: git lfs checkout
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.12'
- name: Install mdbtools
run: |
sudo apt-get update
sudo apt-get install -y mdbtools
- name: Install Poetry
run: |
curl -sSL https://install.python-poetry.org | python3 -
export PATH="$HOME/.local/bin:$PATH"
- name: Install Node.js
uses: actions/setup-node@v2
with:
node-version: '20'
- name: Install Node.js dependencies
run: |
npm install
- name: Install dependencies
run: |
poetry install
- name: Build Sphinx documentation
run: |
poetry run sphinx-build -b html docs/source docs/build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html