Skip to content

PR3: publish paper examples to docs/figures and refresh README#10

Merged
iahncajigas merged 2 commits intomasterfrom
codex/pr3-readme-paper-docs
Mar 5, 2026
Merged

PR3: publish paper examples to docs/figures and refresh README#10
iahncajigas merged 2 commits intomasterfrom
codex/pr3-readme-paper-docs

Conversation

@iahncajigas
Copy link
Copy Markdown
Collaborator

Summary

Implements the PR3 docs/paper-examples deliverables:

  • Added docs publisher entrypoint:
    • tools/publish_examples.m
    • Exports generated figures and published HTML from helpfiles/nSTATPaperExamples.mlx
    • Supports style toggle (modern default, legacy optional)
  • Added citation metadata:
    • CITATION.cff
  • Updated README:
    • MATLAB 2025b quickstart
    • publish_examples usage for modern/legacy
    • generated figure embed from repo-produced output
    • updated repository URL
  • Added generated docs artifacts (from repository code only):
    • docs/figures/paper_examples_modern/figure_001.png
    • docs/figures/paper_examples_legacy/figure_001.png
    • docs/figures/published_html/nSTATPaperExamples_modern.html
    • docs/figures/published_html/nSTATPaperExamples_legacy.html
    • docs/figures/plot_structure_*.json
    • docs/figures/publish_report_*.json

Local verification

Executed on MATLAB 2025b:

addpath('/Users/iahncajigas/Library/CloudStorage/Dropbox/Research/Matlab/nSTAT_currentRelease_Local/tools');
publish_examples('Style','modern','Seed',0);
publish_examples('Style','legacy','Seed',0);

Both runs completed and wrote outputs under docs/figures/.

Notes

  • No publication PDF images were embedded.
  • All figure/html assets were generated directly from repository code.
  • publish_examples defaults to ExecuteLiveScript=false to avoid mutating source .mlx files during docs generation.

Generated figures/docs from repository code (modern + legacy)
@iahncajigas iahncajigas merged commit e56235e into master Mar 5, 2026
0 of 3 checks passed
@iahncajigas iahncajigas deleted the codex/pr3-readme-paper-docs branch March 5, 2026 20:43
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