Scala doc fails to generate static site #15306
Labels
Milestone
Comments
nicolasfara
added
itype:bug
stat:needs triage
|
Can reproduce the issue with 3.1.2. I also tried with 3.1.3-RC4 with the default site root ( |
szymon-rd
added
area:doctool
and removed
stat:needs triage
|
There are few things going on there:
So you define a subsection and then in first element of array you provide only title. You need to define also but this is the root section so the title is always the name of project.
|
ckipp01
pushed a commit
that referenced
this issue
May 29, 2023
- For the first issue, when a user set ./docs to the default value of ScalaSettings, the code only took a value that was not the default `siteRoot.nonDefault`. To fix this, I put a getOrElse to try and get the default value. - For the second problem, I noticed when I cloned the code that the user was calling layouts that did not exist. Be careful with this as it can indeed produce an error. Solving this problem was enough to remove the non-existent layout calls. Fixes: #15306
Kordyjan
pushed a commit
that referenced
this issue
Nov 17, 2023
- For the first issue, when a user set ./docs to the default value of ScalaSettings, the code only took a value that was not the default `siteRoot.nonDefault`. To fix this, I put a getOrElse to try and get the default value. - For the second problem, I noticed when I cloned the code that the user was calling layouts that did not exist. Be careful with this as it can indeed produce an error. Solving this problem was enough to remove the non-existent layout calls. Fixes: #15306 [Cherry-picked 4e4552e]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Compiler version
3.1.2
Minimized code
A minimal repo created accoring to the scaladoc documentation.
Link to example repo: https://github.com/nicolasfara/scaladoc-test
Output
When
-siterootis set to:./docsthesbt doctask is successful but the files indocs/_docs/are ignoreddocsordocs/thesbt doctask fails with the following exception:Stack trace
Expectation
I would expect the
sbt doctask to generate the correct API documentation and render the files contained indocs/_docs.The text was updated successfully, but these errors were encountered: