Fix #8769: change dottydoc root to docs/ subdirectory #9756
Conversation
This file contains hidden or 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
|
Arg, that fails because dottydoc exits with an error if the siteroot doesn't exist, sigh. |
|
Would it work if we instead changed this in SBT for projects where we care about their docs? I think you should be able to pass the option to Dottydoc by modifying |
|
Change what in sbt? I just want the default to not copy a million files and crash sbt |
|
Right, I see the projects that care about it already set |
smarter
force-pushed
the
dottydoc-root
branch
3 times, most recently
from
e80a771 to
b1df97e
Compare
Previously it defaulted to the project root which lead to various issues, notably it meant that the whope project ended up being copied in _site when running `sbt doc`, what's even more fun is that when I tried using sbt 1.4.0-RC1 this caused a compiler crash because it ended up trying to copy a socket file that sbt had created in `target/`. Usincs "docs/" like this still doesn't really make sense when multiple subprojects exist since we'll try using the same directory for all of them, but it's less worse than what we had before and it doesn't seem worth investing more time in dottydoc since it's getting replaced.
smarter
force-pushed
the
dottydoc-root
branch
from
b1df97e to
30d3d0b
Compare
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.
Previously it defaulted to the project root which lead to various
issues, notably it meant that the whope project ended up being copied in
_site when running
sbt doc, what's even more fun is that when I triedusing sbt 1.4.0-RC1 this caused a compiler crash because it ended up
trying to copy a socket file that sbt had created in
target/.Usincs "docs/" like this still doesn't really make sense when multiple
subprojects exist since we'll try using the same directory for all of
them, but it's less worse than what we had before and it doesn't seem
worth investing more time in dottydoc since it's getting replaced.