Fix documentation deployment workflow path order#665
Merged
stevevanhooser merged 7 commits intomainfrom Feb 10, 2026
Merged
Conversation
Moved `addpath(genpath('tools'))` to be executed after `matbox.installRequirements(pwd)` in `.github/workflows/deploy-docs.yml`. This ensures that dependencies installed by MatBox (including `DID-matlab`) are correctly added to the MATLAB path before the build process starts, resolving "file not found" errors during documentation generation.
Updated `.github/workflows/deploy-docs.yml` to: - Execute `matbox.installRequirements(pwd)` before adding `tools` to the path. - Use `fullfile(pwd, 'tools')` for absolute path addition. - Include `disp` and `system` calls to list directory contents for debugging purposes. This resolves dependency path issues during documentation generation.
Updated `.github/workflows/deploy-docs.yml` to: - Move `matbox.installRequirements(pwd)` before adding `tools` to the path. - Use `fullfile(pwd, 'tools')` for absolute path addition. - Include `ls -R /home/runner/work/` to list all files in the runner's work directory recursively for debugging where repositories are installed. This aims to resolve the "file not found" errors by ensuring correct execution order and providing visibility into the CI environment.
Updated `.github/workflows/deploy-docs.yml` to:
- Move `matbox.installRequirements(pwd)` before adding `tools` to the path.
- Use `fullfile(pwd, 'tools')` for absolute path addition.
- Add `addpath(genpath('MATLAB-AddOns'))` after adding `src` to ensure add-ons are included.
- Removed debug listing commands as the issue is identified.
This resolves the "file not found" errors during documentation generation by ensuring all dependencies are correctly on the path.
Updated `.github/workflows/deploy-docs.yml` to: - Add a virtual display server (xvfb) setup step for Linux runners. - Install MatBox requirements into the explicit `tools` directory using `matbox.installRequirements(fullfile(pwd, 'tools'))`. - Retain previous fixes for path ordering, caching, and toolbox installation. This ensures a complete environment for MATLAB documentation generation.
Updated `.github/workflows/deploy-docs.yml` to: - Copy `requirements.txt` to the `tools` directory before installation. - Install dependencies into `tools` using `matbox.installRequirements(fullfile(pwd, 'tools'))`. - Retain Xvfb setup for Linux and toolbox configuration. This ensures requirements are correctly located and installed for the documentation build.
Updated `.github/workflows/deploy-docs.yml` to: - Remove the `ndi_Init()` call as requested. - Retain Xvfb setup, toolbox configuration, and robust path/dependency setup (copying requirements to `tools` and installing there). This finalizes the environment for documentation deployment.
stevevanhooser
approved these changes
Feb 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Moved
addpath(genpath('tools'))aftermatbox.installRequirements(pwd)in.github/workflows/deploy-docs.ymlto fix a dependency loading issue whereDID-matlaband other tools were not being found because the path was set before installation. This change ensures that the installed tools are available in the MATLAB path for the documentation build.PR created automatically by Jules for task 5151705712508955750 started by @stevevanhooser