Skip to content

Add .spi.yml for Swift Package Index DocC support #1102

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Dec 7, 2022
Merged

Add .spi.yml for Swift Package Index DocC support #1102

merged 1 commit into from
Dec 7, 2022

Conversation

yim-lee
Copy link
Contributor

@yim-lee yim-lee commented Dec 2, 2022 •
edited
Loading

Setting up DocC doc on Swift Package Index

@yim-lee yim-lee requested a review from ahoppen as a code owner December 2, 2022 21:09
yim-lee
yim-lee commented Dec 2, 2022
View reviewed changes
@ahoppen
Copy link
Member

ahoppen commented Dec 3, 2022

What do we need .spi.yml for? Is it needed so DocC indexes SPI in addition to the public API?

@yim-lee
Copy link
Contributor Author

yim-lee commented Dec 3, 2022 •
edited
Loading

@ahoppen This is for publishing DocC docs to Swift Package Index: https://blog.swiftpackageindex.com/posts/auto-generating-auto-hosting-and-auto-updating-docc-documentation/

i.e. when this PR gets merged SPI.com will have a "Documentation" link for swift-syntax.

@ahoppen
Copy link
Member

ahoppen commented Dec 4, 2022

Oh, so SPI in this case stands for “Swift Package Index” and not “System Programming Interface” (aka. @_spi).

Could you

  • add a short doc comment to the file stating that
    • this file controls how Swift Package Index builds documentation and is unrelated to the @_spi interface (I imagine other people will also stumble across the confusion)
    • links to the blog post describing the format
  • add all targets as documentation targets except for the underscored and executable targets? Or is there a way to just build documentation for all targets (potentially with a blacklist)?

@yim-lee
Copy link
Contributor Author

yim-lee commented Dec 4, 2022

@ahoppen PR amended. Please review.

yim-lee
yim-lee commented Dec 4, 2022
View reviewed changes
finestructure
finestructure reviewed Dec 4, 2022
View reviewed changes
ahoppen
ahoppen approved these changes Dec 4, 2022
View reviewed changes
Copy link
Member

@ahoppen ahoppen left a comment

Choose a reason for hiding this comment

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

Looks good from my side

@ahoppen
Copy link
Member

ahoppen commented Dec 5, 2022

@swift-ci Please test

yim-lee
yim-lee commented Dec 5, 2022
View reviewed changes
@yim-lee
Copy link
Contributor Author

yim-lee commented Dec 5, 2022

@swift-ci please test

ahoppen
ahoppen reviewed Dec 5, 2022
View reviewed changes
@yim-lee
Copy link
Contributor Author

yim-lee commented Dec 5, 2022

@swift-ci please test

@yim-lee
Copy link
Contributor Author

yim-lee commented Dec 6, 2022

@ahoppen Can you please merge when ready? I don't have write access.

@ahoppen ahoppen merged commit cf00f8a into swiftlang:main Dec 7, 2022
@yim-lee yim-lee deleted the patch-1 branch December 8, 2022 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@finestructure finestructure finestructure left review comments

@ahoppen ahoppen ahoppen approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@yim-lee @ahoppen @finestructure