[Users] How to generate JS API docs with Sphinx and JST

Volker Nathusius nathusius at terrestris.de
Wed May 25 13:10:32 CEST 2011


Hi,

start of May I was also trying to manage a similar way of documenting code based on GeoExt,
and my conclusion was that the GeoExt setup of paver+sphinx+jstools is rather unique.

As far as I could grasp, a virtual python environment is necessary, then the
extraction of JS documentation is managed by paver, which delegates to jstools.

Based on that, I found a workflow that produces API docs, but I would be glad to learn
about a different and more comfortable way, preferably without paver.
I found no manual to jst however...

Regards, Volker




>>/  Hi,
/>>/
/>>/  I am trying to use a similar way to generate API docs within our GeoExt
/>>/  extended components, i.e. using Sphinx with JST templates, but somehow
/>>/  from the GeoExt repository athttp://trac.geoext.org/browser  I can't
/>>/  find out how this is done. Sphinx itself is no problem but somehow I
/>>/  need a "JST" tool that generates .rst files from JS files first ? Also
/>>/  looked into the GXP repository
/>>/  (https://github.com/opengeo/gxp/blob/master/build/build.xml) but to no
/>>/  avail (executable "jst"?).
/>>/
/>>/  Thanks for any help, best,
/>>/
/>>/  --Just
/>>/
/>>/  Just van den Broecke
/>>/  The Netherlands
/>>/  www.justobjects.nl<http://www.justobjects.nl>/




-- 

   Volker von Nathusius

   terrestris GmbH&  Co. KG
   Irmintrudisstraße 17
   53111 Bonn

   Tel:    ++49 (0)228 / 96 28 99 -53
   Fax:    ++49 (0)228 / 96 28 99 -57

   Email:  nathusius at terrestris.de
   Web:    http://www.terrestris.de

   Amtsgericht Bonn, HRA 6835
   Komplementärin:  terrestris Verwaltungsgesellschaft mbH
   vertreten durch: Hinrich Paulsen, Till Adams

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://www.geoext.org/pipermail/users/attachments/20110525/ab04c20a/attachment.htm 


More information about the Users mailing list