Skip to content

Phase 31: Literate notebook examples gallery #183

Description

@gparadis

Goal:
Substantially enhance the examples seed from Phase 30 with actual known-valid Jupyter .ipynb notebook files and matching Sphinx gallery documentation.

The examples follow a literate-programming style: headings and subheadings, explanatory markdown before code, code cells, expected outputs, and enough context that a motivated graduate student can open the notebook and understand what is happening without reverse-engineering package internals.

Release target: modelwright==0.1.0a6

Branch: feature/p31-literate-notebook-examples

Status: complete

Child tasks:

Final evidence:

  • Added examples/notebooks/synthetic-notebook-interface.ipynb.
  • Added examples/notebooks/fable-2020-notebook-interface.ipynb.
  • Sphinx Examples Gallery links to downloadable notebooks.
  • Default tests validate notebook JSON, Python kernel metadata, literate structure, stored outputs, synthetic execution, and static FABLE validation-boundary output.
  • PR Add literate notebook examples gallery #190 merged to main at 3699baa.
  • Annotated tag v0.1.0a6 was pushed.
  • Release workflow run 27978838686 completed successfully and published to PyPI.
  • GitHub prerelease modelwright 0.1.0a6 was created.
  • Clean ignored PyPI install verified modelwright[notebook]==0.1.0a6, import version, notebook helper import, old-import absence, and CLI help.
  • Live GitHub Pages docs verified the Examples Gallery, both notebook example pages, both deployed notebook downloads, and 0.1.0a6 release-deployment content.
  • Closeout commit 12c86ad records the release result in ROADMAP.md and CHANGE_LOG.md.

Acceptance boundary:

  • May claim tracked, known-valid literate notebook examples for synthetic and generated 2020 FABLE notebook/DataFrame workflows.
  • May claim Sphinx Examples Gallery pages that link to actual .ipynb notebooks.
  • Must not claim a full spreadsheet UI, automatic workbook semantic recovery, stable public API compatibility, or Excel-backed recalculation equivalence.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions