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

add api docs to docs dir #1301

Merged
merged 2 commits into from
Dec 12, 2020
Merged

add api docs to docs dir #1301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6302771
add api docs to docs folder
cgardens Dec 11, 2020
9595832
add docs
cgardens Dec 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions airbyte-api/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,18 @@ task generateApiDocs(type: GenerateTask) {
generatePom : "false",
interfaceOnly: "true"
]

doLast {
Copy link
Contributor

Choose a reason for hiding this comment

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

would it make sense to output the docs there by default instead of doing a copy?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

def target = file(rootProject.file("docs/api"))
delete target
mkdir target
copy {
from outputDir
include "**/*.html"
includeEmptyDirs = false
into target
}
}
}
compileJava.dependsOn tasks.generateApiDocs

Expand Down
Loading