Documentation generator

27 views
Skip to first unread message

Felipe Pena

unread,
Mar 4, 2012, 4:41:42 PM3/4/12
to cleve...@googlegroups.com
Hi guys,
Anyone has some suggestion for documentation generator tool? In a
first look into Sphinx (used by Python), it seems restrictive to
Python/C/C++ yet.

I'm being reluctant to use XML, it guess it's better to use a
ReST/Markdown one instead.

--
Regards,
Felipe Pena

Felipe Pena

unread,
Mar 4, 2012, 7:23:28 PM3/4/12
to cleve...@googlegroups.com
Well,

2012/3/4 Felipe Pena <feli...@gmail.com>:

I guess we must try to use the Sphinx. (It's the best tool I've seen
in my search)
We have to start creating the pages [1] and preparing our syntax highlight [2].

[1] - http://sphinx.pocoo.org/tutorial.html
[2] - http://pygments.org/docs/lexerdevelopment/

Priority in the [1] task, help is welcome. :)

--
Regards,
Felipe Pena

Felipe Pena

unread,
Mar 5, 2012, 8:54:16 AM3/5/12
to cleve...@googlegroups.com
Hi again,

2012/3/4 Felipe Pena <feli...@gmail.com>:

I've started the doc, using what we have currently posted in the
current web page.

Doc repository: https://github.com/clever-lang/clever-doc

Command to generate the documentation: sphinx-build -b html . _build
(in the root dir, _build is the output dir)

I'll change the current page to use this new documentation in soon. :)

--
Regards,
Felipe Pena

Murilo Adriano

unread,
Mar 5, 2012, 9:08:35 AM3/5/12
to cleve...@googlegroups.com
Well done Felipe!

Enviado via iPhone

Felipe Pena

unread,
Mar 5, 2012, 9:09:58 AM3/5/12
to cleve...@googlegroups.com
2012/3/5 Murilo Adriano <muri...@gmail.com>:

The initial doc can be viewed on-line now at: http://clever-lang.github.com/doc/

--
Regards,
Felipe Pena

Reply all
Reply to author
Forward
0 new messages