Skip to content

docs: README infer-flow rewrite, RTD auto-build, theory overlay fix#12

Merged
ismayc merged 1 commit into
mainfrom
docs/readme-and-rtd
Jun 19, 2026
Merged

docs: README infer-flow rewrite, RTD auto-build, theory overlay fix#12
ismayc merged 1 commit into
mainfrom
docs/readme-and-rtd

Conversation

@ismayc

@ismayc ismayc commented Jun 19, 2026

Copy link
Copy Markdown
Member

Follow-ups after #11:

  1. Repo metadata — description + homepage set to https://moderndive.readthedocs.io (via repo settings, not this diff).
  2. README — docs link; refreshed What's inside (dual-engine plotly/plotnine plots, df.specify(), custom-statistic calculate(), model plots + new helpers, 58 datasets); Quick start rewritten in the infer df.specify() pipeline flow.
  3. RTD auto-build.github/workflows/rtd-build.yml triggers a Read the Docs build on push to main. One-time: add a READTHEDOCS_TOKEN repo secret (RTD → Account → API tokens). The native RTD GitHub App/webhook is an alternative that makes this workflow unnecessary.
  4. coming-from-r.specify() on its own line in the pipeline example.
  5. theory-based guide — split the method="both" / method="theoretical" cell so the "both" histogram+curve overlay renders (a cell shows only its last value).

Gates: 215 tests / 100% coverage, ruff check + format clean, docs build warning-free under -W.

🤖 Generated with Claude Code

…ecify fixes

- README: link to moderndive.readthedocs.io, refresh "What's inside" (dual-engine
  plots, df.specify(), custom statistics, model plots, new helpers, 58 datasets),
  rewrite Quick start in the infer df.specify() pipeline flow.
- Add .github/workflows/rtd-build.yml to trigger a Read the Docs build on pushes
  to main (needs a READTHEDOCS_TOKEN secret; native webhook is an alternative).
- theory-based guide: split the method="both"/"theoretical" cell so the "both"
  histogram+curve overlay renders (a cell shows only its last value).
- coming-from-r: put .specify() on its own line in the pipeline example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog
@ismayc ismayc merged commit 5cca63d into main Jun 19, 2026
6 checks passed
ismayc added a commit that referenced this pull request Jun 19, 2026
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog
ismayc added a commit that referenced this pull request Jun 19, 2026
* docs: document count_missing()

count_missing() (per-column null counts) was added with its function, top-level
export, and tests, but wasn't in the docs. Add it to the API reference and a
short getting-started example.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog

* docs(readme): list count_missing in What's inside

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog

* docs: rebuild HTML after merging main (#12)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017CTL1QSTg1DmDUpqYuPEog

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
@ismayc ismayc deleted the docs/readme-and-rtd branch June 19, 2026 19:51
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