Skip to content

406 add docstrings #300

406 add docstrings

406 add docstrings #300

Workflow file for this run

name: Generate Python Documentation
on: [pull_request]
jobs:
build-docs:
runs-on: ubuntu-22.04
steps:
- name: Install SSH_KEYS
uses: webfactory/[email protected]
with:
ssh-private-key: |
${{ secrets.SSH_PRIVATE_KEY_REACHY2_SDK_API }}
- name: Checkout Repository
uses: actions/checkout@v3
- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
- name: Generate Documentation
run: pdoc reachy2_sdk --output-dir docs --logo "https://www.pollen-robotics.com/img/company/logo/pollen_logo_square_black.svg"
- name: Archive Documentation
uses: actions/upload-artifact@v4
with:
name: documentation
path: docs/