Skip to content

dottydoc copies whole project into _site #8769

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.

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

Closed
adamw opened this issue Apr 22, 2020 · 0 comments
Closed

dottydoc copies whole project into _site #8769

adamw opened this issue Apr 22, 2020 · 0 comments

Comments

@adamw
Copy link
Contributor

adamw commented Apr 22, 2020

When running publishLocal for a project build using sbt-dotty, the whole project is copied into the _site directory. Moreover, the generated -javadoc artifact is empty.

To reproduce, see: https://github.com/softwaremill/sttp-model. Remove the setting regarding sources in (Compile, doc) (which disables documentation generation for dotty) and run + publishLocal from sbt.

Example empty javadoc artifact: https://repo1.maven.org/maven2/com/softwaremill/sttp/model/core_0.22/1.1.0/
(well, almost, it contains the manifest file)

smarter added a commit to dotty-staging/dotty that referenced this issue Sep 8, 2020
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 socketfile 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 added a commit to dotty-staging/dotty that referenced this issue Sep 8, 2020
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 socketfile 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 added a commit to dotty-staging/dotty that referenced this issue Sep 8, 2020
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 added a commit to dotty-staging/dotty that referenced this issue Sep 18, 2020
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 added a commit to dotty-staging/dotty that referenced this issue Sep 18, 2020
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 added a commit to dotty-staging/dotty that referenced this issue Sep 18, 2020
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.
abgruszecki added a commit that referenced this issue Sep 21, 2020
Fix #8769: change dottydoc root to docs/ subdirectory
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants