-
Notifications
You must be signed in to change notification settings - Fork 60
Render combined navigation for merged documentation archives #877
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
Render combined navigation for merged documentation archives #877
Conversation
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 :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Tested and it looks great.
Code looks good to me too!
@swift-ci test |
…ng#877) rdar://124537023 Render combined navigation for merged documentation archives (swiftlang#877) rdar://124537023
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
swiftlang/swift-docc#821
Testing
You can use this fixture which combines docs for
Inner
andOuter
modules into a combinedMy Project
archive:MyCombinedDocs.doccarchive.zip
Steps:
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