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.

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

Add docs generation #468

Closed
keith opened this issue Aug 11, 2020 · 3 comments · Fixed by #619
Closed

Add docs generation #468

keith opened this issue Aug 11, 2020 · 3 comments · Fixed by #619

Comments

@keith
Copy link
Member

keith commented Aug 11, 2020

https://github.com/bazelbuild/stardoc
@alexeagle
Copy link
Contributor

Maybe I can help with this, I just added stardoc to rules_docker

@keith
Copy link
Member Author

keith commented Apr 29, 2021

that would be awesome!

alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
9e11dfe 
See bazelbuild#468
@alexeagle alexeagle mentioned this issue Apr 30, 2021
Merged
alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
70a8d29 
This replaces the rules.md file with a reformat of the same content, generated from the swift.bzl entry point file.

To verify this, I did a careful side-by-side manual comparison of
https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md
vs
https://github.com/bazelbuild/rules_swift/blob/9e11dfe6855b4d0a095495379145debd3c6d1158/doc/rules.md
and copied over the couple of relevant differences.

See bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
d8707bb 
This replaces the rules.md file with a reformat of the same content, generated from the swift.bzl entry point file.

To verify this, I did a careful side-by-side manual comparison of
https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md
vs
https://github.com/bazelbuild/rules_swift/blob/9e11dfe6855b4d0a095495379145debd3c6d1158/doc/rules.md
and copied over the couple of relevant differences.

See bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
9c903c2 
This replaces the rules.md file with a reformat of the same content, generated from the swift.bzl entry point file.

To verify this, I did a careful side-by-side manual comparison of
https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md
vs
https://github.com/bazelbuild/rules_swift/blob/9e11dfe6855b4d0a095495379145debd3c6d1158/doc/rules.md
and copied over the couple of relevant differences.

See bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
5ac3528 
This replaces the rules.md file with a reformat of the same content, generated from the swift.bzl entry point file.

To verify this, I did a careful side-by-side manual comparison of
https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md
vs
https://github.com/bazelbuild/rules_swift/blob/9e11dfe6855b4d0a095495379145debd3c6d1158/doc/rules.md
and copied over the couple of relevant differences.

See bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue Apr 30, 2021
@alexeagle
Add first stardoc API docgen target
35fd240 
This replaces the rules.md file with a reformat of the same content, generated from the swift.bzl entry point file.

To verify this, I did a careful side-by-side manual comparison of
https://github.com/bazelbuild/rules_swift/blob/master/doc/rules.md
vs
https://github.com/bazelbuild/rules_swift/blob/9e11dfe6855b4d0a095495379145debd3c6d1158/doc/rules.md
and copied over the couple of relevant differences.

See bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue May 19, 2021
@alexeagle
Generate setup.md from sources
c9e35d3 
This is the last doc that should be generated from sources, but wasn't, from what I can tell.
Fixes bazelbuild#468
alexeagle added a commit to alexeagle/rules_swift that referenced this issue May 19, 2021
@alexeagle
Generate setup.md from sources
39b1c1e 
This is the last doc that should be generated from sources, but wasn't, from what I can tell.
Fixes bazelbuild#468
@alexeagle alexeagle mentioned this issue May 19, 2021
Merged
@thii thii closed this as completed in #619 May 19, 2021
@alexeagle
Copy link
Contributor

By the way, now that this uses stardoc, it looks a lot better on our "g3doc for rulesets"
https://docs.aspect.dev/rules_swift
😎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Generate setup.md from sources alexeagle/rules_swift
2 participants
@alexeagle @keith