Skip to content

Conversation

@mmcky
Copy link
Collaborator

@mmcky mmcky commented Nov 19, 2025

Purpose

This PR tests the integration of sphinx-tojupyter PR #62 with the continuous_time_mcs lecture series.

Changes

  • Updated environment.yml to install sphinx-tojupyter from PR [generators]10_correct_or_clarify #62 (commit 0cdef691)
  • Added quantecon and numba dependencies for notebook execution
  • Added comprehensive testing documentation

Testing Documentation

COMPARISON_REPORT.md

Detailed comparison between v0.6.0 and PR #62:

  • ✅ All 10 notebooks build successfully
  • ✅ Cross-references improved in 7/10 notebooks (full URLs → local anchors)
  • ✅ No content loss or breaking changes
  • ℹ️ Thebe configuration now embedded in notebooks

THEBE_ISSUE.md

Documents Thebe configuration behavior:

  • HTML/JavaScript Thebe config added as markdown cells
  • Affects all 10 notebooks
  • Provides solutions for future enhancement

Key Findings

Improvements:

  1. Better cross-references (offline-friendly local anchors)
  2. All notebooks execute and build correctly
  3. Full backward compatibility maintained

New Behavior:

  • Thebe configuration embedded for website round-trip support
  • See THEBE_ISSUE.md for details and proposed solutions

GitHub Actions

Please review the GitHub Actions workflow results to validate the build with PR #62.

Related

- Updated environment.yml to install from PR #62 (commit 0cdef691)
- Added quantecon and numba dependencies for notebook execution
- Added COMPARISON_REPORT.md with detailed v0.6.0 vs PR #62 analysis
- Added THEBE_ISSUE.md documenting Thebe configuration in notebooks

Key findings:
- All notebooks build successfully with PR #62
- Cross-references improved (7/10 notebooks)
- Thebe configuration present in all notebooks (new behavior)
- See COMPARISON_REPORT.md and THEBE_ISSUE.md for details
- Removed deprecated tojupyter_target_html setting
- This option was removed in sphinx-tojupyter v2.0
- Was causing build warning: 'unknown config value'
- Eliminates warning without changing notebook output
- Thebe configuration still present (as expected, handled by hardcoded behavior)
@github-actions
Copy link

github-actions bot commented Nov 19, 2025

@github-actions github-actions bot temporarily deployed to pull request November 19, 2025 03:34 Inactive
- Remove COMPARISON_REPORT.md (superseded by final report)
- Remove THEBE_ISSUE.md (issue resolved in PR #62)
- Add FINAL_COMPARISON_REPORT.md with complete v0.6.0 vs PR #62 analysis
- Update .gitignore to exclude .DS_Store files

Final report confirms PR #62 is production-ready with:
- 68 cross-references converted to full URLs for portability
- Zero regressions from v0.6.0
- Clean output with no unwanted HTML/JS blocks
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.

2 participants