Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add doc command to generate documentation via underlying scaladoc

See original GitHub issue

Is your feature request related to a problem? Please describe. It would be really nice to be able to generate documentation without having to switch to sbt or install the scala binaries manually.

Describe the solution you’d like Let scala-cli doc . generate documentation for the code in the current dir, for example written to a dir named doc or similar.

Additional context This would mean that scala-cli needs to install and call scaladoc. There are also various options to scaladoc that somehow should be possible to control from scala-cli doc

Issue Analytics

State:
Created a year ago
Comments:5 (5 by maintainers)

Top GitHub Comments

1reaction

lwronskicommented, May 9, 2022

I agree, that there should be a user-friendly option for generating documentation.

Instead of giving hint how to extract the jar, it wants to add a new flag/command that will generate the documentation I’m trying to do it in #991

0reactions

bjornregnellcommented, May 5, 2022

So one easy fix for now is that the scala-cli package --doc commant could give a hint on how to unpack the jar to get the site with some helpful message printed? People might be used to the sbt doc behavior where the site is not jarred but available uncompressed in target, and it is perhaps not obvious that the jar contains the static site…

Top Results From Across the Web

Guide to Scaladoc | Baeldung on Scala

In this tutorial, we'll learn how to add Scaladoc to code for a Scala project. Then, we'll generate the Scaladoc from the added...

How to generate Scala documentation with the 'scaladoc' ...

To generate Scaladoc API documentation, document your code using Scaladoc ... the documentation using an SBT task or the scaladoc command.

Generating Scaladoc

There are two ways to generate API documentation in HTML from your Scala code. Those options are: use sbt to do it,; use...

Scaladoc tutorial for docs.scala-lang.org

Using Scaladoc. scaladoc is able to generate documentation for your code based on the doc comments you added in the source code. But...

14.8. Generating Documentation with scaladoc

To generate Scaladoc API documentation, document your code using Scaladoc tags, and then create the documentation using an SBT task or the scaladoc...