Disable API doc generation when publishing #169
Merged
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
|
👍 seems to make sense to me. |
|
👍 |
non
added a commit
that referenced
this pull request
Feb 10, 2015
Disable API doc generation when publishing
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.
Attempting to publish currently fails during Scaladoc generation with a lot of "Could not find any member to link for…" errors, due to the fact that we have links across subprojects in the API docs (and that we treat warnings as failures).
It seems like
autoAPIMappingsshould fix this, but it currently doesn't have any effect. It's possible to make automatic mapping work in this situation by jumping through this hoop, but the fact that we don't really care about thedoctask (since we're usingunidoc) means it's probably simplest just to remove it from publishing.I've also added
publishLocalto the Travis build to help ensure that we don't break publishing in the future. It could be added tovalidatecommand alias, but it has wider effects than what you'd normally think of as validation, so adding it as an extra step in the Travis script seemed like a better idea.