Update Python API Reference #16
This file contains hidden or 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
| name: Update Python API Reference | |
| on: | |
| schedule: | |
| - cron: "0 23 * * 5" # Runs at 23:00 UTC every Friday | |
| workflow_dispatch: # Run on manual trigger | |
| jobs: | |
| build: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Free space | |
| run: df -h && rm -rf /opt/hostedtoolcache* && df -h | |
| - name: Install dependencies (pip) | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install quantconnect-stubs mkdocs mkdocs-material "mkdocstrings[python]" black | |
| - name: Run the Python API Reference Generator | |
| working-directory: code-generators/python_api_reference | |
| run: python main.py | |
| - name: Build site with MkDocs | |
| working-directory: code-generators/python_api_reference | |
| run: mkdocs build --clean | |
| - name: Configure AWS Credentials | |
| uses: aws-actions/configure-aws-credentials@v1 | |
| with: | |
| aws-access-key-id: ${{ secrets.AWS_KEY }} | |
| aws-secret-access-key: ${{ secrets.AWS_SECRET }} | |
| aws-region: us-west-1 | |
| - name: Upload the site to S3 | |
| working-directory: code-generators/python_api_reference | |
| run: aws s3 cp ./site s3://content.quantconnect.com/docs/v2/lean-engine/class-reference/py/ --recursive --acl bucket-owner-full-control |