This page is no longer maintained — Please continue to the home page at www.scala-lang.org

Re: [Lift committers] [vscaladoc2] work in progress

No replies
david.bernard
Joined: 2009-01-08,
User offline. Last seen 1 year 27 weeks ago.

Hi Derek,

Short :
Currently, it required webapp front-end.

Long (extract from vscaladoc2-genjson/README.md) :

--8<---------------------------------------------------------------------------------------------
What about static html generation ?

Or why not providing a static json -> html tool ?

Because I want :

* to create a "central" place to browse api,
* to ease aggregration/cross project reference (with dynamic update),
it's hard and not evolutive to achieve with static generation
* to allow reader to browse api of severals project with his
"preferences" (not available)

A possible future solution could be to provide a standalone viewer
(local http-webapp) with the abilities :

* to browse a local repository of api-data (json format)
* to sniff/capture remote api

Like this user will be able to browse off-line and to access all the
benefit of the central "repository"

One of the target (I forgot to list) is to simplify )

Note : You could create your own tool, (or pay me to make it) ;-)
--8<---------------------------------------------------------------------------------------------

On Thu, Nov 4, 2010 at 00:04, Derek Chen-Becker wrote:
> I've been trying to follow all of the emails on this list and others about
> various Scala doc projects and one question I have with this is: does it
> require a webapp front-end, or will it provide a HTML+JavaScript impl so
> that it can be used in a disconnected mode on a local machine?
>
> Derek
>
> On Wed, Nov 3, 2010 at 4:47 PM, David Bernard
> wrote:
>>
>> Hi,
>>
>> A quick note to inform about progression of Vscaladoc2.
>>
>> Vscaladoc2 is an api documentation tools (suite) :
>>
>> * vscaladoc2_genjson : extract api from scala source into json files
>> (store under $HOME/.config/vscaladoc2/apis)
>>  http://github.com/davidB/vscaladoc2_genjson
>> * vscaladoc2_demoprj : a sample project (with lot of case of
>> documention, /** ... */ in *.scala, overview.html, package.html,...)
>>  http://github.com/davidB/vscaladoc2_demoprj
>> * vscaladoc2_www : a webapp use to display api (html, json) and cross
>> link reference support linking to external apidoc in Scaladoc,
>> Scaladoc2, Javadoc2
>>  http://github.com/davidB/vscaladoc2_www
>>
>> You could see first results of vscaladoc2 on-line at
>> http://vscaladoc.alchim31.net/ (run vscaladoc2_www)
>>
>> The current version is pretty slow, mainly because the web server
>> (hosted in U.S.A) doesn't host original data api in json format.
>> I deployed (as sample) the api in json format on a French server :
>> http://alchim31.free.fr/apis/
>>
>> /davidB
>>
>> --
>> You received this message because you are subscribed to the Google Groups
>> "Lift-committers" group.
>> To post to this group, send email to lift-committers [at] googlegroups [dot] com.
>> To unsubscribe from this group, send email to
>> lift-committers+unsubscribe [at] googlegroups [dot] com.
>> For more options, visit this group at
>> http://groups.google.com/group/lift-committers?hl=en.
>>
>
> --
> You received this message because you are subscribed to the Google Groups
> "Lift-committers" group.
> To post to this group, send email to lift-committers [at] googlegroups [dot] com.
> To unsubscribe from this group, send email to
> lift-committers+unsubscribe [at] googlegroups [dot] com.
> For more options, visit this group at
> http://groups.google.com/group/lift-committers?hl=en.
>

Copyright © 2012 École Polytechnique Fédérale de Lausanne (EPFL), Lausanne, Switzerland