Ensure that synthesized landing pages for combined archives display page images and links in abstracts from referenced types #1179
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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:
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 theDOCC_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.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded[ ] Updated documentation if necessary