Re: API documentation from introspection data

2012-02-24 Thread Alberto Ruiz
2012/2/24 Tomeu Vizoso to...@sugarlabs.org That sounds great functionality. The webapp will file bugs in BZ and attach patches to it? Or will maintainers have to go through the webapp? We can figure something out, for now it's just an idea, haven't thought of the best way to implement it.

Re: API documentation from introspection data

2012-02-24 Thread Luc Pionchon
On Tue, Feb 21, 2012 at 18:08, Stefan Sauer enso...@hora-obscura.de wrote: On 02/19/2012 03:41 PM, Shaun McCance wrote: On Sun, 2012-02-19 at 12:48 +0100, Stefan Sauer wrote: Just one thought. If people work on a next generation doc tool to take over from gtk-doc, please consider to do it

Re: API documentation from introspection data

2012-02-24 Thread Tomeu Vizoso
On Fri, Feb 24, 2012 at 11:57, Alberto Ruiz ar...@gnome.org wrote: 2012/2/24 Tomeu Vizoso to...@sugarlabs.org That sounds great functionality. The webapp will file bugs in BZ and attach patches to it? Or will maintainers have to go through the webapp? We can figure something out, for now

Re: API documentation from introspection data

2012-02-24 Thread Stefan Sauer
On 02/23/2012 09:27 PM, Alberto Ruiz wrote: Well, this is not quite true Stefan, Right now if you want to contribute to the docs you have to do quite a bit of work (git+bugzilla workflow), even if you do this everyday, it can be quite annoying and distracting to stop everything that you are

Re: API documentation from introspection data

2012-02-23 Thread Shaun McCance
On Tue, 2012-02-21 at 17:08 +0100, Stefan Sauer wrote: On 02/19/2012 03:41 PM, Shaun McCance wrote: On Sun, 2012-02-19 at 12:48 +0100, Stefan Sauer wrote: Just one thought. If people work on a next generation doc tool to take over from gtk-doc, please consider to do it without docbook xml

Re: API documentation from introspection data

2012-02-23 Thread Stefan Sauer
On 02/23/2012 04:18 PM, Shaun McCance wrote: snip Honestly, I think all of us (me included) are getting too hung up on the tools. What we really need is better writing. No amount of tool development is going to save you from a lack of good content. Agree, but one important part is that the

Re: API documentation from introspection data

2012-02-23 Thread Martin Robinson
On Thu, Feb 23, 2012 at 11:15 AM, Stefan Sauer enso...@hora-obscura.de wrote: Honestly, I think all of us (me included) are getting too hung up on the tools. What we really need is better writing. No amount of tool development is going to save you from a lack of good content. Agree, but one

Re: API documentation from introspection data

2012-02-23 Thread Alberto Ruiz
Well, this is not quite true Stefan, Right now if you want to contribute to the docs you have to do quite a bit of work (git+bugzilla workflow), even if you do this everyday, it can be quite annoying and distracting to stop everything that you are doing to ammend documentation (opening a bug

Re: API documentation from introspection data

2012-02-23 Thread Tomeu Vizoso
On Thu, Feb 23, 2012 at 21:27, Alberto Ruiz ar...@gnome.org wrote: Well, this is not quite true Stefan, Right now if you want to contribute to the docs you have to do quite a bit of work (git+bugzilla workflow), even if you do this everyday, it can be quite annoying and distracting to stop

Re: API documentation from introspection data

2012-02-22 Thread Mikkel Kamstrup Erlandsen
On 18 February 2012 07:47, Tomeu Vizoso to...@tomeuvizoso.net wrote: ...snip... We started generating DocBook from GIR files, trying to mimic GTK-Doc as much as possible. Progress was slow and we had quite some problems trying to rescue the DocBook that is embedded in the C sources. Shaun

Re: API documentation from introspection data

2012-02-21 Thread Stefan Sauer
On 02/19/2012 03:41 PM, Shaun McCance wrote: On Sun, 2012-02-19 at 12:48 +0100, Stefan Sauer wrote: Just one thought. If people work on a next generation doc tool to take over from gtk-doc, please consider to do it without docbook xml at all. Just go from an intermediate representation to

Re: API documentation from introspection data

2012-02-19 Thread Shaun McCance
On Sat, 2012-02-18 at 15:00 +, Alberto Ruiz wrote: I am interested in the dynamic features like doing complicated queries to show the result and being able to add comments and code examples to specific API items, writing code to output Mallard only helps if you want to still produce

Re: API documentation from introspection data

2012-02-19 Thread Stefan Sauer
On 01/13/2012 02:17 PM, Tomeu Vizoso wrote: Hi, in a bit less than a month from now there will be a hackfest on documentation in Brno [0]. Has anybody done any further work since Berlin in generating API documentation in the Mallard format from the GIR files? I plan to spend my time there

Re: API documentation from introspection data

2012-02-19 Thread Shaun McCance
On Sun, 2012-02-19 at 12:48 +0100, Stefan Sauer wrote: Just one thought. If people work on a next generation doc tool to take over from gtk-doc, please consider to do it without docbook xml at all. Just go from an intermediate representation to html *without* xslt. libxslt is literally dead

Re: API documentation from introspection data

2012-02-19 Thread Alberto Ruiz
2012/2/19 Shaun McCance sha...@gnome.org On Sat, 2012-02-18 at 15:00 +, Alberto Ruiz wrote: I am interested in the dynamic features like doing complicated queries to show the result and being able to add comments and code examples to specific API items, writing code to output Mallard

Re: API documentation from introspection data

2012-02-19 Thread Tomeu Vizoso
On Sun, Feb 19, 2012 at 16:22, Alberto Ruiz ar...@gnome.org wrote: 2012/2/19 Shaun McCance sha...@gnome.org On Sat, 2012-02-18 at 15:00 +, Alberto Ruiz wrote: I am interested in the dynamic features like doing complicated queries to show the result and being able to add comments and

Re: API documentation from introspection data

2012-02-19 Thread Jasper St. Pierre
On Sun, Feb 19, 2012 at 10:22 AM, Alberto Ruiz ar...@gnome.org wrote: Django has its own comments app, that problem is already solved. And it's terrible. Speaking as someone who wrote the rating/comment system using the Django comments app, it's terrible. Don't think of adding any feature

Re: API documentation from introspection data

2012-02-19 Thread Alberto Ruiz
2012/2/19 Tomeu Vizoso to...@tomeuvizoso.net On Sun, Feb 19, 2012 at 16:22, Alberto Ruiz ar...@gnome.org wrote: 2012/2/19 Shaun McCance sha...@gnome.org On Sat, 2012-02-18 at 15:00 +, Alberto Ruiz wrote: I am interested in the dynamic features like doing complicated queries

Re: API documentation from introspection data

2012-02-19 Thread Jasper St. Pierre
On Sun, Feb 19, 2012 at 1:25 PM, Alberto Ruiz ar...@gnome.org wrote: I think that a tool to convert the doc string into something C/Python/Vala/GJS friendly (with links to each node) would be nice. If it had some sort of integration with the AST it would be nice so that we could somehow

Re: API documentation from introspection data

2012-02-18 Thread Alberto Ruiz
2012/2/18 Tomeu Vizoso to...@tomeuvizoso.net On Fri, Jan 27, 2012 at 16:33, Alberto Ruiz ar...@gnome.org wrote: 2012/1/27 Alberto Ruiz ar...@gnome.org Hello guys, Just for the record, I've started coding a small django app in github to see how far can I get with regards a richer

Re: API documentation from introspection data

2012-02-17 Thread Tomeu Vizoso
On Fri, Jan 27, 2012 at 16:33, Alberto Ruiz ar...@gnome.org wrote: 2012/1/27 Alberto Ruiz ar...@gnome.org Hello guys, Just for the record, I've started coding a small django app in github to see how far can I get with regards a richer API reference web interface. I'm reusing Mikkael

Re: API documentation from introspection data

2012-01-27 Thread Shaun McCance
On Fri, 2012-01-27 at 09:49 +0100, Tomeu Vizoso wrote: On Sat, Jan 14, 2012 at 23:30, Colin Walters walt...@verbum.org wrote: On Fri, 2012-01-13 at 14:17 +0100, Tomeu Vizoso wrote: Hi, in a bit less than a month from now there will be a hackfest on documentation in Brno [0]. Has anybody

Re: API documentation from introspection data

2012-01-27 Thread Alberto Ruiz
Hello guys, Just for the record, I've started coding a small django app in github to see how far can I get with regards a richer API reference web interface. I'm reusing Mikkael Kampstrup's giraffe[1] AST code for GIR and I'm translating that to a django data model (SQL) structure. There are two

Re: API documentation from introspection data

2012-01-27 Thread Alberto Ruiz
2012/1/27 Alberto Ruiz ar...@gnome.org Hello guys, Just for the record, I've started coding a small django app in github to see how far can I get with regards a richer API reference web interface. I'm reusing Mikkael Kampstrup's giraffe[1] AST code for GIR and I'm translating that to a

Re: API documentation from introspection data

2012-01-14 Thread Colin Walters
On Fri, 2012-01-13 at 14:17 +0100, Tomeu Vizoso wrote: Hi, in a bit less than a month from now there will be a hackfest on documentation in Brno [0]. Has anybody done any further work since Berlin in generating API documentation in the Mallard format from the GIR files? I don't think

API documentation from introspection data

2012-01-13 Thread Tomeu Vizoso
Hi, in a bit less than a month from now there will be a hackfest on documentation in Brno [0]. Has anybody done any further work since Berlin in generating API documentation in the Mallard format from the GIR files? I plan to spend my time there on this, so would be great if I can avoid stepping