Documentation format for ATS: Doxygen vs Sphinx

[Yannick Duchêne]

Unless I'm wrong, it seems to me the ATS environment favours Doxygen as its documentation format (I remember I've seen multiple Doxygen documents somewhere around ATS). Out of curiosity, I'm interested in learning the reasons of this choice, and to know if Sphinx was considered.

To be honest, I feel Sphinx documents are more handy/readable/useful for documentation than that of Doxygen are.

Not a grief, it's only about Doxygen vs Sphinx, something not related to ATS in the first place, and by the way, I don't totally enjoy Sphinx neither, I just prefer it over Doxygen.

If someone know anything about the reasons, please, tell.

[Brandon Barker]

I am not familiar with these, though I've heard of doxygen. Hongwei uses his own tool, atsdoc (see wiki). Chris Double used AsciiDoc here: https://github.com/doublec/ats-reference. Not sure what I might be missing.

--
You received this message because you are subscribed to the Google Groups "ats-lang-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to ats-lang-user...@googlegroups.com.
To post to this group, send email to ats-lan...@googlegroups.com.
Visit this group at http://groups.google.com/group/ats-lang-users.
To view this discussion on the web visit https://groups.google.com/d/msgid/ats-lang-users/1df9f32e-e9f1-4c66-a436-56bfd4f26dbc%40googlegroups.com.

[Yannick Duchêne]

Le jeudi 21 août 2014 07:21:58 UTC+2, Brandon Barker a écrit :

I am not familiar with these, though I've heard of doxygen. Hongwei uses his own tool, atsdoc (see wiki). Chris Double used AsciiDoc here: https://github.com/doublec/ats-reference. Not sure what I might be missing.

May be that's me who is missing something. I was feeling to remember I've seen Doxygen documentations.

What you say suggest there is not only used, but may be multiple. That was worth to be mentioned, thanks.

[gmhwxi]

Steinway did some doc using Sphinx:

https://github.com/steinwaywhw/ats-docs-and-tips

[Steinway Wu]

Hi, sorry my site is out-of-date for a long time. I should join your ATS github wiki page.

[Yannick Duchêne]

Le jeudi 21 août 2014 17:29:47 UTC+2, Steinway Wu a écrit :

Hi, sorry my site is out-of-date for a long time. I should join your ATS github wiki page.

Hi  Steinway,

Did you used an ATS‑mode or was it documents authored without extraction from ATS source?

[Steinway Wu]

Hi Yannick, 

The sources are on github, the final outputs are here: http://ats-docs-and-tips.readthedocs.org/en/latest/

Sphinx don't have an ATS mode, I just used ocaml instead actually. Currently I have only SublimeText syntax highlighting and ACE Editor syntax highlighting.