Skip to content

Fix docs workflow by installing build dependencies before Poetry#15

Merged
lmangani merged 2 commits into
masterfrom
copilot/update-docs-workflow-dependencies
Feb 12, 2026
Merged

Fix docs workflow by installing build dependencies before Poetry#15
lmangani merged 2 commits into
masterfrom
copilot/update-docs-workflow-dependencies

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 10, 2026

The docs workflow fails when Poetry attempts to build madmom and vamp packages because they require Cython and numpy at build time.

Changes

  • Install Cython>=0.29.0 and numpy>=1.21.0,<2.0.0 before running ./scripts/install.sh in the docs workflow
  • Mirrors the successful pattern already implemented in general.yml (lines 41-43)
- name: Install dependencies
  run: |
    sudo apt-get update
    sudo apt-get install libsndfile1
    # Install build dependencies first (required for madmom and vamp)
    pip install --upgrade pip setuptools wheel
    pip install "Cython>=0.29.0" "numpy>=1.21.0,<2.0.0"
    ./scripts/install.sh
    pip install sphinx sphinx-press-theme sphinx-click 
    pip install sphinxcontrib-bibtex numpydoc
Original prompt

Problem

The docs workflow (.github/workflows/doc-build.yml) is failing during dependency installation because Poetry cannot build packages like madmom and vamp which require build-time dependencies (Cython and numpy) that aren't installed yet.

Error logs show:

ModuleNotFoundError: No module named 'numpy'
ModuleNotFoundError: No module named 'Cython'

Solution

Following the pattern from the successful .github/workflows/general.yml workflow (lines 40-50), we need to install build dependencies before running the Poetry installation step.

Changes Required

Update .github/workflows/doc-build.yml to install Cython and numpy before running ./scripts/install.sh:

In the "Install dependencies" step (around line 59-65), add the build dependency installation before calling the install script:

      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install libsndfile1
          # Install build dependencies first (required for madmom and vamp)
          pip install --upgrade pip setuptools wheel
          pip install "Cython>=0.29.0" "numpy>=1.21.0,<2.0.0"
          ./scripts/install.sh
          pip install sphinx sphinx-press-theme sphinx-click 
          pip install sphinxcontrib-bibtex numpydoc

This ensures that when Poetry tries to build madmom and vamp, the required build dependencies are already available in the environment.

Reference

The successful approach is already implemented in .github/workflows/general.yml at lines 41-47.

This pull request was created from Copilot chat.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Update docs workflow to install build dependencies Fix docs workflow by installing build dependencies before Poetry Feb 10, 2026
Copilot AI requested a review from lmangani February 10, 2026 11:57
@lmangani lmangani marked this pull request as ready for review February 12, 2026 22:24
@lmangani lmangani merged commit 30b0aea into master Feb 12, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants