add api docs to docs dir #1301
Merged
add api docs to docs dir #1301
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sherifnada
reviewed
Dec 12, 2020
| @@ -98,6 +98,18 @@ task generateApiDocs(type: GenerateTask) { | |||
| generatePom : "false", | |||
| interfaceOnly: "true" | |||
| ] | |||
|
|
|||
| doLast { | |||
There was a problem hiding this comment.
would it make sense to output the docs there by default instead of doing a copy?
There was a problem hiding this comment.
mostly trying to keep the pattern the same where we generate to the build dir, and then separately copy it where it needs to go. i think building to something outside of module is not great. i'm also not sure the gen allows it, but i can double check.
sherifnada
approved these changes
Dec 12, 2020
michel-tricot
approved these changes
Dec 12, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We build API docs but they just get dumped in a build dir. Trying to at least dump them in
docs/so that we can refer contributors to them. Tried this before and was having issues with ensuring a clean repository, hoping will be okay this time.