Skip to content

Fix Pages deployment and docs navigation#3

Merged
mhmdaskari merged 1 commit into
mainfrom
fix-pages-deployment
May 23, 2026
Merged

Fix Pages deployment and docs navigation#3
mhmdaskari merged 1 commit into
mainfrom
fix-pages-deployment

Conversation

@mhmdaskari

@mhmdaskari mhmdaskari commented May 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • Enables cleaner GitHub Pages deployment by fetching full history for the revision-date plugin.
  • Updates the official Pages workflow actions to their current Node 24 major versions.
  • Skips the deploy job outside main, so manual branch validation can build the docs without being rejected by the protected github-pages environment.
  • Splits the generated API reference into a nested MkDocs tree for configuration, data, preprocessing, augmentation, framework models, plotting, CLI, and constants.
  • Excludes .ipynb files from GitHub Linguist language detection so the repository language bar emphasizes Python rather than notebooks.

Deployment note

The repository Pages setting has also been enabled through the GitHub Pages API with build_type=workflow, which fixes the Get Pages site failed / Not Found error from actions/configure-pages.

Validation

  • CUDA_VISIBLE_DEVICES=-1 mkdocs build --strict
  • git check-attr linguist-detectable -- notebooks/00_data_postprocessing.ipynb
  • Verified GitHub Pages API now reports build_type: workflow for https://mhmdaskari.github.io/EEG_DL_Classification/.

@mhmdaskari mhmdaskari force-pushed the fix-pages-deployment branch from 6ee8447 to abc4ac0 Compare May 23, 2026 08:17
@mhmdaskari mhmdaskari merged commit 0670ad5 into main May 23, 2026
2 checks passed
@mhmdaskari mhmdaskari changed the title Fix GitHub Pages documentation workflow Fix Pages deployment and docs navigation May 23, 2026
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.

1 participant