Skip to content

Update for PSI 0.34 compat, Literate cleanup and add precommit#69

Merged
jd-lara merged 9 commits into
jd/misc_fixesfrom
kd/literate-clean
May 18, 2026
Merged

Update for PSI 0.34 compat, Literate cleanup and add precommit#69
jd-lara merged 9 commits into
jd/misc_fixesfrom
kd/literate-clean

Conversation

@kdayday

@kdayday kdayday commented May 5, 2026

Copy link
Copy Markdown
Contributor

This pull request introduces several improvements to the documentation build pipeline, tutorial generation scripts, and test utilities. The main changes focus on making tutorial download links and image notes context-aware (working correctly for previews, dev, tags, and stable deployments), improving DataFrame rendering in documentation, and updating test logic for compatibility with changes in how simulation data is stored (PSI 0.34).

Testing and Simulation Updates:

  • Test utilities have been updated for compatibility with PSI 0.34+: simulation results are now detected via the presence of a data_store directory rather than JSON files, and system population is requested explicitly when fetching decision problem results. [1] [2] [3]
  • Obsolete helper functions for finding system files in test data have been removed.

Documentation and Tutorial Generation Improvements:

  • Apply cleanup from Add literate.jl docs infrastructure PowerFlows.jl#356
  • The tutorial build pipeline (docs/make_tutorials.jl) now computes the documentation base URL dynamically based on the deployment context, ensuring that download/view links work correctly for preview, dev, tagged, and stable builds. Download links can be absolute or relative depending on the environment or override variables. [1] [2]
  • Image "view online" notes in generated notebooks are now appended only once per cell and detect multiple image formats, improving the user experience for Jupyter notebook viewers.
  • DataFrame rendering in tutorials is now bounded by environment variables, preventing large outputs from overwhelming documentation pages. The output size can be configured with SIENNA_DOCS_DF_MAX_ROWS and SIENNA_DOCS_DF_MAX_COLS.
  • The tutorial generation process is more robust: it cleans up both .md and .ipynb artifacts, and the pipeline is better documented and organized. (docs/make_tutorials.jlL56-R141, F59bbd0eL406R463)

CI and Formatting Enhancements:

  • The documentation preview cleanup workflow now only runs for non-forked pull requests, preventing permission issues.
  • The docs CI workflow sets the DOCUMENTER_CURRENT_VERSION environment variable appropriately for previews, tags, and branches, ensuring correct URL generation in all contexts.
  • A pre-commit hook for Julia code formatting has been added, improving code quality and consistency.

Other Minor Changes:

  • The hardcoded _DOCS_BASE_URL in docs/make.jl has been removed in favor of dynamic computation.
  • The serialize keyword argument was removed from a build! call in a tutorial scenario script, reflecting upstream API changes.

Copilot AI and others added 3 commits April 20, 2026 18:31
* Initial plan

* Update legacy org, docs domain, and Slack workspace references

Agent-Logs-Url: https://github.com/Sienna-Platform/PowerAnalytics.jl/sessions/f7d7ad47-b1c6-439f-a209-13e78403092c

Co-authored-by: jd-lara <16385323+jd-lara@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jd-lara <16385323+jd-lara@users.noreply.github.com>
@kdayday kdayday changed the title Literate cleanup Literate cleanup and add precommit May 5, 2026
@codecov

codecov Bot commented May 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.04%. Comparing base (db2974a) to head (25992dc).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #69   +/-   ##
=======================================
  Coverage   88.04%   88.04%           
=======================================
  Files           7        7           
  Lines         669      669           
=======================================
  Hits          589      589           
  Misses         80       80           
Flag Coverage Δ
unittests 88.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@kdayday kdayday mentioned this pull request May 5, 2026
@kdayday

kdayday commented May 5, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Make a draft PR into this PR that fixes the existing documentation example errors while retaining the intention of the tutorial

Copilot AI commented May 5, 2026

Copy link
Copy Markdown
Contributor

@kdayday I've opened a new pull request, #70, to work on those changes. Once the pull request is ready, I'll request review from you.

@kdayday kdayday requested a review from jd-lara May 7, 2026 18:38
Copilot AI and others added 3 commits May 7, 2026 18:46
Fix docs tutorial failures: update PSI compat to 0.34, drop deprecated `serialize` kwarg
@kdayday

kdayday commented May 7, 2026

Copy link
Copy Markdown
Contributor Author

@copilot Edit the PR comment with a summary of the PR changes

Copilot AI commented May 7, 2026

Copy link
Copy Markdown
Contributor

@copilot Edit the PR comment with a summary of the PR changes

Updated the PR description with a summary of all changes: literate cleanup (DataFrame display, docs workflow), pre-commit config, and the doc tutorial fixes from #70 (PSI 0.34 compat, removed deprecated serialize kwarg, updated test fixtures for new data storage format).

Copilot finished work on behalf of kdayday May 7, 2026 21:37
@kdayday kdayday changed the title Literate cleanup and add precommit Update for PSI 0.34 compat, Literate cleanup and add precommit May 7, 2026
@jd-lara jd-lara changed the base branch from main to jd/misc_fixes May 18, 2026 17:29
@jd-lara jd-lara merged commit e400a58 into jd/misc_fixes May 18, 2026
@jd-lara jd-lara deleted the kd/literate-clean branch May 28, 2026 17:08
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