SWIFT-734 Update scripts to maintain multiple versions of the documentation #601
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
patrickfreed
commented
Feb 5, 2021
| --module-version "${version}") | ||
|
|
||
| # Generate MongoSwift docs | ||
| sourcekitten doc --spm --module-name MongoSwift > mongoswift-docs.json |
There was a problem hiding this comment.
this was required to make the script work on Linux.
| @@ -0,0 +1,17 @@ | |||
| import os | |||
There was a problem hiding this comment.
I really loathe bash scripting (and I can't write it either) so I just made another python script.
kmahar
approved these changes
Feb 5, 2021
There was a problem hiding this comment.
nice, LGTM!
this got me thinking about getting the BSON lib symbols to show up in these docs going forward... I think we discussed this but don't think we have a ticket about it 🤔 opened SWIFT-1113
|
Good point, also I need to port this setup over to the BSON library too, since it probably makes sense for it to host its own docs as well. I'll do a follow up PR in |
This was referenced Feb 5, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
SWIFT-734
This PR updates the release and documentation scripts to generate the docs in a way that works for multiple versions of the driver, based on SwiftNIO's setup. See #600 for the changes it makes to the
gh-pagesbranch (or rather, check out the branch of my fork, since that diff is crazy).