API docs as HTML

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

API docs as HTML

Offray Vladimir Luna Cárdenas-2
Hi,

For the JOSS (Journal of Open Source Software) I need to add to a
package documentation the API documentation as an external file
(hopefully in HTML). So I would like to export the source code in a way
that can be used as API documentation. I remember that some API
documentation about Smalltalk/Pharo can be found online, but I don't
know how to produce such documents. Any pointers to explore?

Cheers,

Offray



Reply | Threaded
Open this post in threaded view
|

Re: API docs as HTML

EstebanLM
this was the webdoc project (made originally by Camillo Bruni) 


but… you will need to massage it a bit to make it work :)
also, Guille made a simplification some time ago… he will know where it is or what’s his status.

Esteban

On 9 Aug 2017, at 16:41, Offray Vladimir Luna Cárdenas <[hidden email]> wrote:

Hi,

For the JOSS (Journal of Open Source Software) I need to add to a
package documentation the API documentation as an external file
(hopefully in HTML). So I would like to export the source code in a way
that can be used as API documentation. I remember that some API
documentation about Smalltalk/Pharo can be found online, but I don't
know how to produce such documents. Any pointers to explore?

Cheers,

Offray




Reply | Threaded
Open this post in threaded view
|

Re: API docs as HTML

Offray Vladimir Luna Cárdenas-2

Thanks Esteban,

Any documentation to start with? How can I install this?

Cheers,

Offray


On 09/08/17 10:08, Esteban Lorenzano wrote:
this was the webdoc project (made originally by Camillo Bruni) 


but… you will need to massage it a bit to make it work :)
also, Guille made a simplification some time ago… he will know where it is or what’s his status.

Esteban

On 9 Aug 2017, at 16:41, Offray Vladimir Luna Cárdenas <[hidden email]> wrote:

Hi,

For the JOSS (Journal of Open Source Software) I need to add to a
package documentation the API documentation as an external file
(hopefully in HTML). So I would like to export the source code in a way
that can be used as API documentation. I remember that some API
documentation about Smalltalk/Pharo can be found online, but I don't
know how to produce such documents. Any pointers to explore?

Cheers,

Offray