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

Generate and publish documentation with swift-doc #49

Merged
merged 5 commits into from
Sep 15, 2020
Merged

Conversation

MaxDesiatov
Copy link
Contributor

@MaxDesiatov MaxDesiatov commented Sep 14, 2020

You can see the deployment at https://swiftwasm.github.io/JavaScriptKit/.

I'll update the trigger to deploy only on pushes to master if you think this is something we should proceed with.

@MaxDesiatov MaxDesiatov added the documentation Improvements or additions to documentation label Sep 14, 2020
@j-f1
Copy link
Member

j-f1 commented Sep 15, 2020

Looks like there’s some cleanup necessary in the “functions” category — all of those should be private imo. It also doesn’t properly handle standard Swift types — is there a way to link those to developer.apple.com?

@MaxDesiatov
Copy link
Contributor Author

I'll clean things up, but cross-module references unfortunately aren't supported in swift-doc yet 😔

@MaxDesiatov
Copy link
Contributor Author

Everything seems to work when @_cdecl functions are made internal, so they are no longer displayed in the docs now.

@MaxDesiatov MaxDesiatov marked this pull request as ready for review September 15, 2020 09:16
Copy link
Member

@kateinoigakukun kateinoigakukun left a comment

Choose a reason for hiding this comment

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

Nice!

@kateinoigakukun kateinoigakukun merged commit f97dca1 into master Sep 15, 2020
@kateinoigakukun kateinoigakukun deleted the swift-doc branch September 15, 2020 11:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants