Closed mportiz08 closed 4 months ago
Marking this as a draft PR for the moment after talking with @d-ronnqvist offline. I'll need to make some additional changes to support the situation where multiple modules have been bundled together under a parent module.
I've updated the PR description with more up-to-date info and testing instructions. This should be ready now and ended up being simpler than I originally anticipated once I got access to some better fixture data :)
@swift-ci test
Bug/issue #, if applicable: 124537023
Summary
Now that Swift-DocC can merge multiple documentation archives together into a single archive, it will provide navigator data that includes a combined index for all the pages in the archive. This change updates Swift-DocC-Render to render this combined data for all the pages in the navigator.
Example:
Dependencies
https://github.com/apple/swift-docc/pull/821
Testing
You can use this fixture which combines docs for
Inner
andOuter
modules into a combinedMy Project
archive: MyCombinedDocs.doccarchive.zipSteps:
MyCombinedDocs.doccarchive.zip
fixture and checkout this branch of Swift-DocC-RenderVUE_APP_DEV_SERVER_PROXY=/path/to/MyCombinedDocs.doccarchive npm run serve
and open http://localhost:8080/documentationInner
andOuter
docsKnown DocC issue: the breadcrumb link to "My Project" from the getting started article doesn't work due to a bug with the compiler data pointing to the wrong URL (should be /documentation and not /documentation/my-project)
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
npm test
, and it succeeded