Skip to content

Pass on new updates#669

Merged
stevevanhooser merged 39 commits intodocs-stimulus-reader-instructions-11064462993643526816from
main
Feb 16, 2026
Merged

Pass on new updates#669
stevevanhooser merged 39 commits intodocs-stimulus-reader-instructions-11064462993643526816from
main

Conversation

@stevevanhooser
Copy link
Copy Markdown
Contributor

No description provided.

stevevanhooser and others added 30 commits January 30, 2026 21:15
This workflow:
1. Triggers on new published releases or manual dispatch.
2. Sets up Python and installs MkDocs with Material theme.
3. Sets up MATLAB and installs dependencies via MatBox.
4. Runs `ndi.docs.build()` to generate documentation.
5. Moves generated `mkdocs.yml` and `docs` folder to the root.
6. Deploys the documentation to GitHub Pages using `mkdocs gh-deploy`.
This workflow:
1. Triggers on new published releases or manual dispatch.
2. Sets up Python and installs MkDocs with Material theme.
3. Sets up MATLAB and installs dependencies via MatBox.
4. Runs `ndi.docs.build()` to generate documentation.
5. Moves generated `mkdocs.yml` and `docs` folder to the root to match MkDocs structure.
6. Deploys the documentation to GitHub Pages using `mkdocs gh-deploy`.
…7516092

Add automated documentation deployment workflow
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.
This commit fixes a bug in `ndi.dataset.dir` where legacy `dataset_session_info` documents were being converted twice on the second opening of a dataset.

The issue was caused by checking the result of a fresh search (`dataset_session_info_docs2`) but then passing the possibly stale/inaccessible documents from an earlier search (`dataset_session_info_docs`) to `repairDatasetSessionInfo`.

The fix ensures that:
1. `repairDatasetSessionInfo` is only called if the fresh search `dataset_session_info_docs2` is not empty.
2. The fresh search result `dataset_session_info_docs2` (which contains documents visible to the current session) is passed to `repairDatasetSessionInfo`.
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.
…9080307406821141344

Fix double conversion of legacy dataset sessions in ndi.dataset.dir
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.
…8955750

Fix documentation deployment workflow path order
Update prepare-release-modular.yml
@stevevanhooser stevevanhooser merged commit 8c4f123 into docs-stimulus-reader-instructions-11064462993643526816 Feb 16, 2026
17 checks 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.

3 participants