Skip to content
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

update docs generation script to match latest source-kitten #2013

Merged
merged 1 commit into from
Dec 16, 2021

Conversation

tomerd
Copy link
Member

@tomerd tomerd commented Dec 16, 2021

motivation: fix broken doc generation script

changes:

  • pass the --spm flag now required by source-kitten
  • update location of source-kitten source to make it more robust
  • update list of module to generate docs for to match the structural changes in nio

motivation: fix broken doc generation script

changes:
* pass the --spm dlaf now required by source-kitten
* update location of source-kitten source to make it more robust
* update list of module to generate docs for to match the structural changes in nio
@tomerd tomerd changed the title update doc script to match altest source-kitten update docs generation script to match latest source-kitten Dec 16, 2021
@glbrntt glbrntt added the needs-no-version-bump For PRs that when merged do not need a bump in version number. label Dec 16, 2021
Copy link
Contributor

@glbrntt glbrntt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Tomer!

@glbrntt glbrntt merged commit b5c662a into apple:main Dec 16, 2021
@tomerd
Copy link
Member Author

tomerd commented Dec 16, 2021

@glbrntt may be worth going over the the NIO repos and making sure their doc generation script is updated the same way.

it can be tested locally with: docker-compose -f docker/docker-compose.yaml -f docker/docker-compose.2004.54.yaml run --rm shell -clx scripts/generate_docs.sh

glbrntt added a commit to glbrntt/swift-nio-http2 that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten

Result:

Docs build.
glbrntt added a commit to glbrntt/swift-nio-http2 that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
glbrntt added a commit to glbrntt/swift-nio-extras that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Add NIOSOCKS module
- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
glbrntt added a commit to glbrntt/swift-nio-ssl that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
@glbrntt
Copy link
Contributor

glbrntt commented Dec 17, 2021

Thanks -- I updated the other NIO repos

glbrntt added a commit to apple/swift-nio-http2 that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
glbrntt added a commit to apple/swift-nio-ssl that referenced this pull request Dec 17, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
glbrntt added a commit to apple/swift-nio-extras that referenced this pull request Dec 20, 2021
Motivation:

The docs haven't been generated for a while.

See also: apple/swift-nio#2013

Modifications:

- Add NIOSOCKS module
- Pass `--spm` flag to sourcekitten
- Update source location of sourcekitten
- Fix link to NIO docs

Result:

Docs build.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-no-version-bump For PRs that when merged do not need a bump in version number.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants