Skip to content

docs: add the paper's graphical abstract to the README and docs landing page - #4

Merged
adowling2 merged 1 commit into
mainfrom
docs-graphical-abstract
Aug 7, 2026
Merged

docs: add the paper's graphical abstract to the README and docs landing page#4
adowling2 merged 1 commit into
mainfrom
docs-graphical-abstract

Conversation

@adowling2

Copy link
Copy Markdown
Contributor

Adds the published article's official graphical abstract as the visual summary on the README
and the documentation landing page.

  • File: docs/graphical_abstract.jpg (157 KB, 1333×570) — Elsevier's graphical abstract
    for the article, redistributed under CC BY 4.0
    on the same basis as the already-bundled paper/bits_for_gaps_paper.pdf. Attribution
    appears in both captions.
  • README: placed directly under the tagline and referenced by an absolute
    raw.githubusercontent.com URL, so it renders on the PyPI project page as well as on
    GitHub — relative image paths do not resolve on PyPI.
  • Docs: a MyST figure directive with a caption that explains the three panels
    (hierarchical GP surrogate → entropy-maximizing sampling loop → information-optimal
    predictions), placed above the Reference admonition.
  • Both use descriptive alt text rather than "graphical abstract", so the figure conveys
    something to screen-reader users.

Verified: sphinx-build -W clean, and the image is copied into the built site under
_images/.

🤖 Generated with Claude Code

…ng page

Adds docs/graphical_abstract.jpg (157 KB, 1333x570) -- the published article's official
graphical abstract, redistributed under CC BY 4.0 like the bundled PDF, with attribution
in both captions.

- README: placed under the tagline, referenced by absolute raw.githubusercontent URL so it
  renders on the PyPI project page as well as on GitHub (relative paths don't resolve on
  PyPI).
- docs/index.md: a MyST `figure` with a caption summarizing the three panels, above the
  Reference admonition.
- Descriptive alt text on both, rather than a bare "graphical abstract", so the figure is
  meaningful to screen readers.

sphinx-build -W clean; the image is copied into the built site (_images/).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@adowling2
adowling2 merged commit bdd7b73 into main Aug 7, 2026
5 checks passed
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