Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure that synthesized landing pages for combined archives display page images and links in abstracts from referenced types #1179

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

d-ronnqvist
Copy link
Contributor

@d-ronnqvist d-ronnqvist commented Mar 19, 2025

Bug/issue #, if applicable: rdar://147392201

Summary

This includes the dependency references of the merged archives in the synthesized landing page so that modules with page images display those images on the landing page:

Screenshot 2025-03-19 at 15 58 00

Dependencies

None

Testing

For a project with multiple targets, for example https://github.com/d-ronnqvist/combined-documentation-example

  • Add images and @PageImage directives to one or more of the documented products.

  • Add a link in the abstract of one or more of the documented products.

  • Build a local docc executable from this branch and specify its path for the DOCC_EXEC environmental variable.

  • Build a combined documentation archive using swift package generate-documentation --enable-experimental-combined-documentation

  • Start a preview server and preview the combined archives's landing page.

    • Both the page images and the abstract links should display on the landing page. Note that the entire card is a single element, so the abstract link isn't clickable.

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • [ ] Updated documentation if necessary

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