Why scaladoc can not handle http doc hosting

[ghost]

By the document we can see:

cd scaladoc/output
python3 -m http.server 8080

How hard is it we have a builtin http static server hosting the document ?

why we need python?

We already have scala, who need a python3 as well?

suggest: why not put a http server inside scaladoc

scaladoc serve -p :8080

that can hosting document in localhost:8080

[SethTisue]

I normally view generated Scaladoc without using any HTTP server at all — I just open the HTML files in my browser directly. But I see that the doc says:

It’s not strictly necessary to go through an HTTP server, but because of CORS the documentation won’t work completely if you don’t

Note that JDK 17 added https://docs.oracle.com/en/java/javase/17/docs/api/jdk.httpserver/module-summary.html which could be used instead of Python for this — for users who are on JDK 17 or higher, anyway.

[julienrf]

FWIW, the IDE IntelliJ provides an HTTP server for you (click on a file, and then select Open in browser). This is what I use, currently.

I agree that it would be good to put something in the documentation that does not rely on Python, though… In which page of the documentation is this?

[ghost]

https://github.com/lampepfl/dotty/blob/main/scaladoc/README.md

I hope scaladoc itself can buitin a simple http server.

[julienrf]

(pinging @pikinier20)

[ghost]

import com.sun.net.httpserver.HttpExchange;
import com.sun.net.httpserver.HttpHandler;
import com.sun.net.httpserver.HttpServer;

I guess we can implement a very simple Http static file server only depends on JDK api

[ghost]

or any other better solution

[ckipp01]

Wanted to drop in here and say that this should 100% be a part of Scaladoc. I find it super odd that the Scaladoc instructions mention using Python to view them to get the full features. Just in general I don't think people will expect this, and apart from the readme, it wasn't part of the docs. I just opened this to try to make that clearer, but I really don't think this should be relying on Python.

[julienrf]

Note that there is also sbt-site, which does provide an HTTP server. Several documentation website generators (e.g. paradox) rely on sbt-site for watching the generated documentation. Maybe that solution should be considered? Integrating with sbt-site would also bring other benefits such as working out of the box with sbt-ghpage.

[ckipp01]

It'd be great if there could be a build-tool agnostic way.

[floating-cat]

JDK 18 also has provided a jwebserver command based on com.sun.net.httpserver which could use the below command to start an HTTP server: https://openjdk.org/jeps/408

jwebserver
// with specified port 
jwebserver -p 8080