API documentation

[Philippe Veber]

Hi guys,

I've just checked the API documentation (which I had not done in a while) and noticed the fine changes that took place (presentation and links to the source code). Kudos for those who did this!

cheers,
  ph.

[Sebastien Mondet]

Hi

Glad you like it !

All the black-magic is in the (reasonably ugly) ocamldoc plugin: https://github.com/biocaml/biocaml/blob/v0.3-dev/src/odoc/biohtml.ml

Any feedback is welcome:
- some functions have now figures explaining them: http://biocaml.org/doc/dev/api/Biocaml_transform.html#VALcompose

- I've tried to minimize the number of "clicks" to get to some value by inlining submodules as much as possible (that's actually most of the code of the plugin)

- the "include Some_signature.S" even got an "expand button" like there: http://biocaml.org/doc/dev/api/Biocaml_stream.html

- the "frame" that appears when mouse-overing some piece of documentation was initially for debugging but I kinda liked it, so it's still there.

More stuff could be done:

- the links to the  code of function go to a page containing *only* the code of that function, it would be nice to point to a specific line of the whole ".ml", so that one can see the context and other functions/types

- using "with sexp" in the mli files messes ocamldoc up (it's not the plugin, it happens everywhere), so for now one has to write the "val sexp_of_t ... val t_of_sexp", it would be cool to have a nice general solution for boilerplate code.

cheers

Seb

--
You received this message because you are subscribed to the Google Groups "biocaml" group.
To unsubscribe from this group and stop receiving emails from it, send an email to biocaml+u...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

[Philippe Veber]

Wow, that's reaaaaally neat! And BTW the ocamldoc plugin does not seem that awful to me. Also, the "with sexp" issue should disappear with the upcoming of attributes so ...

Thanks again, this is good stuff for advertising the library!

2013/4/19 Sebastien Mondet <sebastie...@gmail.com>

[Francois Berenger]

On 04/20/2013 12:03 AM, Sebastien Mondet wrote:
>
> Hi
>
> Glad you like it !
>
>
> All the black-magic is in the (reasonably ugly) ocamldoc plugin:
> https://github.com/biocaml/biocaml/blob/v0.3-dev/src/odoc/biohtml.ml

I am really impressed!