A simple tool to generate a static html representation of scala source-code?

On Fri, Jul 29, 2011 at 10:49 AM, bnord wrote:
> I'm looking for a simple tool (preferably a sbt or maven plugin) to generate
> a nice
> html representation of scala source-code which can be included in the
> scala-docs just as in the
> official scala-api-docs but as static html so that it can easily be
> distributed and viewed offline.
>
> I had no luck with any web-searches. Maybe I just don't know the right
> buzzwords.
>
> Does anyone know of any such tool? I'm quiet confident that such a thing
> must exist somewhere.
> Sadly the scala webpage doesn't refer to any.

We use Scala X-Ray [1] for the annotated Scalaz sources (example [2]).

-jason

[1] https://github.com/harrah/browse
[2] http://scalaz.github.com/scalaz/scalaz-2.9.0-1-6.0/doc.sxr/scalaz/exampl...

There's Scala x-ray which seems to do exactly what you want:

https://github.com/harrah/browse/

On Fri, Jul 29, 2011 at 10:49 AM, bnord wrote:
> I'm looking for a simple tool (preferably a sbt or maven plugin) to generate
> a nice
> html representation of scala source-code which can be included in the
> scala-docs just as in the
> official scala-api-docs but as static html so that it can easily be
> distributed and viewed offline.
>
> I had no luck with any web-searches. Maybe I just don't know the right
> buzzwords.
>
> Does anyone know of any such tool? I'm quiet confident that such a thing
> must exist somewhere.
> Sadly the scala webpage doesn't refer to any.
>
> Many thanks in advance!
>
>

On 29/07/2011 10:49, bnord wrote:
> I'm looking for a simple tool (preferably a sbt or maven plugin) to generate a nice
> html representation of scala source-code which can be included in the scala-docs

For reference, I wrote a Scala lexer for Scintilla (advertised in this list some time
ago). It isn't totally finished (eg. it needs better handling of XML literals) but it is
quite usable. It is a simple syntax highlighting lexer, nothing sophisticated.

I mention it because when used in SciTE, you can export source code to HTML, PDF, RTF,
LaTeX, XML formats. Alas, it is an interactive process (open file, use menu to export).

Might be an interesting exercise to rewrite it in Scala, for batch processing.