adding docset to files copied into gh-pages dir #1478
Conversation
|
Can one of the admins verify this patch? |
9 similar comments
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
Can one of the admins verify this patch? |
|
@swift-nio-bot test this please |
scripts/generate_docs.sh
Outdated
| @@ -108,6 +108,7 @@ if [[ $PUSH == true ]]; then | |||
| rm -rf "docs/$version" | |||
| rm -rf "docs/current" | |||
| cp -r "$jazzy_dir/docs/$version" docs/ | |||
| cp -r "$jazzy_dir/docset/$version" docset/ | |||
There was a problem hiding this comment.
iirc the better fix would be to remove the --docset-path argument. I originally added it so that the docset won't be included in what we push to gh-pages. the reason was size - this is quite big and make the repo fairly heavy afaict.
There was a problem hiding this comment.
Makes sense - worked for me, and should be pretty straightforward to do. I'll update the PR tomorrow for that.
There was a problem hiding this comment.
yes, this is what I wanted to suggest. we can potentially also post docs to s3 and serve them up from there, or a separate git repo can also work.
There was a problem hiding this comment.
@tomerd I'm 100% in favour of S3 or separate repo. I feel you're much better positioned to choose what the best option is. If we can keep the generated docs outside this repo, I'd be happier :)
adding docset to files copied into gh-pages dir
Motivation:
I noticed the missing link when perusing swift-metrics, and after having submitted a fix there, I was told the same script was used here, so I thought it might be convenient to have the same fix (apple/swift-metrics#69) propagated here.
Modifications:
added a line to copy the docset files in addition to the docs
Result:
Future updates should also include docset files for swift-metrics on
additional publications to gh-pages by authors.