Skip to content

Update the usage of docc#865

Merged
ktoso merged 2 commits intoapple:mainfrom
Kyle-Ye:docc
Dec 12, 2021
Merged

Update the usage of docc#865
ktoso merged 2 commits intoapple:mainfrom
Kyle-Ye:docc

Conversation

@Kyle-Ye
Copy link
Copy Markdown
Contributor

@Kyle-Ye Kyle-Ye commented Dec 11, 2021

  • Remove docc and docc render build
  • Update README.md to reflect docc change

Motivation:

#856

#863

Modifications:

Update scripts/docs/generate_docc.sh and scripts/docs/preview_docc.sh

Update the README description about docc and update the recommend swift-nightly-toolchain to 2021-11-02

Since the docc and docc-render ship with the toolchain from that tag swiftlang/swift#39723

Result:

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

6 similar comments
@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?

@swift-server-bot
Copy link
Copy Markdown

Can one of the admins verify this patch?


declare -r SWIFT="$TOOLCHAIN/usr/bin/swift"

# all our public modules which we want to document, begin with `DistributedActors`
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This a duplication to the above line

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Should we add "DistributedActorsTestKit" to sync with the "modules" definition in preview_docc.sh

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, I think you're right -- we want to document the testkit too 👍

@Kyle-Ye
Copy link
Copy Markdown
Contributor Author

Kyle-Ye commented Dec 11, 2021

Test result:

It previews properly on this branch

Screen Shot 2021-12-11 at 11 46 59

@Kyle-Ye
Copy link
Copy Markdown
Contributor Author

Kyle-Ye commented Dec 11, 2021

Could you help with reviewing this PR @ktoso ❤️

@ktoso ktoso self-requested a review December 12, 2021 05:20
@ktoso
Copy link
Copy Markdown
Member

ktoso commented Dec 12, 2021

This looks good! I need to get the project in sync with the december toolchains but that's the right step for docc! Thank you!

@ktoso ktoso merged commit 86c92f4 into apple:main Dec 12, 2021
@Kyle-Ye Kyle-Ye deleted the docc branch December 12, 2021 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Since DocC now ships in toolchains, adjust scripts/docs/generate... to not have to download/build docc

3 participants