Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-12 Thread Simon Feltman
On Mon, Mar 10, 2014 at 7:48 AM, Christoph Reiter reiter.christ...@gmail.com wrote: On Mon, Mar 10, 2014 at 4:27 AM, Simon Feltman s.felt...@gmail.com wrote: In terms of overrides having additional side effects beyond the intended GI API, I really hope we can deprecate those scenarios or

Re: Coordination for developer documentations

2014-03-10 Thread Tomeu Vizoso
On 7 March 2014 17:45, meg ford meg...@gmail.com wrote: It would also be awesome if whoever takes the lead on this makes sure that the functionality we are documenting actually works. If we want devs to be able to write GNOME apps then having documentation that matches the functionality they

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-10 Thread Frederic Peters
Stefan Sauer wrote: On 03/08/2014 06:15 PM, Christoph Reiter wrote: I've tried the devhelp export and it seemed to work quite well for the all in one API docs. But I'm not sure how linking between different Sphinx builds would work with devhelp. (but I have no idea how devhelp does it

Re: Coordination for developer documentations

2014-03-10 Thread meg ford
On 7 March 2014 17:45, meg ford meg...@gmail.com wrote: It would also be awesome if whoever takes the lead on this makes sure that the functionality we are documenting actually works. If we want devs to be able to write GNOME apps then having documentation that matches the functionality

Re: Coordination for developer documentations

2014-03-10 Thread Allan Day
Frederic Peters fpet...@gnome.org wrote: ... Developer documentation will be a topic during the Developer Experience Hackfest, but I believe we will fail again to provide lasting effects if nobody takes on a coordination role. ... But I'm a bit lost since the decisions that were agreed at the

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-10 Thread Christoph Reiter
On Sun, Mar 9, 2014 at 11:35 PM, Stefan Sauer enso...@hora-obscura.de wrote: devhelp is basically the index.sgml (ignore the sgml extension, it is not) + prerendered html. devhelp does not do anything with the link in the html doc, except trying to follow them when one is clicked. OK, thanks

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-10 Thread Christoph Reiter
On Mon, Mar 10, 2014 at 4:27 AM, Simon Feltman s.felt...@gmail.com wrote: On Sat, Mar 8, 2014 at 9:15 AM, Christoph Reiter reiter.christ...@gmail.com wrote: On Sat, Mar 8, 2014 at 4:04 AM, Simon Feltman s.felt...@gmail.com wrote: * GI function argument interpretation for Python docs would be

Re: Coordination for developer documentations

2014-03-09 Thread Stefan Sauer
On 03/08/2014 02:31 AM, Alberto Ruiz wrote: Pull requests are not encouraged, we tell anyone that tries one to go to Bugzilla/ML and we cancel it. I see. The pull requests would lower the barrier to fix docs. Stefan 2014-03-07 22:58 GMT+01:00 Stefan Sauer enso...@hora-obscura.de

Re: Coordination for developer documentations

2014-03-09 Thread meg ford
On Sun, Mar 9, 2014 at 11:54 AM, Stefan Sauer enso...@hora-obscura.dewrote: I see. The pull requests would lower the barrier to fix docs. There was a lengthy discussion of this on the foundation-list last August, and a follow-up email from Karen in September regarding the Board's decision

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-09 Thread Stefan Sauer
On 03/08/2014 06:15 PM, Christoph Reiter wrote: On Sat, Mar 8, 2014 at 4:04 AM, Simon Feltman s.felt...@gmail.com wrote: That would be helpful. I think it would be nice to integrate your work (or abstracted parts of it) with pygobject itself. An idea that has been cooking in the back of my

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-09 Thread Simon Feltman
On Sat, Mar 8, 2014 at 9:15 AM, Christoph Reiter reiter.christ...@gmail.com wrote: On Sat, Mar 8, 2014 at 4:04 AM, Simon Feltman s.felt...@gmail.com wrote: * GI function argument interpretation for Python docs would be as close as possible to pygobject by having the argument translation code

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-08 Thread John Stowers
Simon and others, With respect to PyGObject docs, I hope you are all aware of http://lazka.github.io/pgi-docs/ and http://learngtk.org/ The first link is especially fantastic. FWIW I also purchased www.pygobject.org a while ago and am wondering what to do with it. My current plan is to

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-08 Thread Christoph Reiter
On Sat, Mar 8, 2014 at 4:04 AM, Simon Feltman s.felt...@gmail.com wrote: That would be helpful. I think it would be nice to integrate your work (or abstracted parts of it) with pygobject itself. An idea that has been cooking in the back of my mind (and to a very small degree has been realized

Re: Python Docs (was Re: Coordination for developer documentations)

2014-03-08 Thread Simon Feltman
On Sat, Mar 8, 2014 at 1:52 AM, John Stowers john.stowers.li...@gmail.com wrote: Simon and others, With respect to PyGObject docs, I hope you are all aware of http://lazka.github.io/pgi-docs/ and http://learngtk.org/ The first link is especially fantastic. Yep, Christoph's (lazka) API docs

Re: Coordination for developer documentations

2014-03-07 Thread Christoph Reiter
On Thu, Mar 6, 2014 at 11:37 AM, Ekaterina Gerasimova kittykat3...@gmail.com wrote: On 6 March 2014 10:07, Christoph Reiter reiter.christ...@gmail.com wrote: Since it wasn't mentioned so far; outside of gnome.org, on the Python side of things, there exists the GTK+ 3 tutorial [0] maintained by

Re: Coordination for developer documentations

2014-03-07 Thread Tomeu Vizoso
On 4 March 2014 16:58, Frederic Peters fpet...@gnome.org wrote: Hey, It's been proved again in recent hackfests, we have a really great team writing user documentations, and thanks have to be given to Shaun, and now Kat, for coordinating the effort. On the other hand we have absolutely no

Re: Coordination for developer documentations

2014-03-07 Thread meg ford
It would also be awesome if whoever takes the lead on this makes sure that the functionality we are documenting actually works. If we want devs to be able to write GNOME apps then having documentation that matches the functionality they can access using the the language application developer docs

Re: Coordination for developer documentations

2014-03-07 Thread Stefan Sauer
On 03/06/2014 05:41 PM, Sébastien Wilmet wrote: On Tue, Mar 04, 2014 at 07:05:30PM +0100, Frederic Peters wrote: I was mostly concerned by our technical infrastructure for developer documentation, but that itself has of course been driven by the content we produced (or wanted to produce), so I

Re: Coordination for developer documentations

2014-03-07 Thread Alberto Ruiz
Pull requests are not encouraged, we tell anyone that tries one to go to Bugzilla/ML and we cancel it. 2014-03-07 22:58 GMT+01:00 Stefan Sauer enso...@hora-obscura.de: On 03/06/2014 05:41 PM, Sébastien Wilmet wrote: On Tue, Mar 04, 2014 at 07:05:30PM +0100, Frederic Peters wrote: I was

Python Docs (was Re: Coordination for developer documentations)

2014-03-07 Thread Simon Feltman
On Fri, Mar 7, 2014 at 3:22 AM, Christoph Reiter reiter.christ...@gmail.com wrote: On Thu, Mar 6, 2014 at 11:37 AM, Ekaterina Gerasimova kittykat3...@gmail.com wrote: On 6 March 2014 10:07, Christoph Reiter reiter.christ...@gmail.com wrote: Since it wasn't mentioned so far; outside of

Re: Coordination for developer documentations

2014-03-06 Thread Christoph Reiter
(responding to the wrong mail since I just subscribed and don't bother modifying mail headers..) Since it wasn't mentioned so far; outside of gnome.org, on the Python side of things, there exists the GTK+ 3 tutorial [0] maintained by Sebastian Pölsterl (accepts pull requests, but isn't actively

Re: Coordination for developer documentations

2014-03-06 Thread Ekaterina Gerasimova
On 6 March 2014 10:07, Christoph Reiter reiter.christ...@gmail.com wrote: (responding to the wrong mail since I just subscribed and don't bother modifying mail headers..) Since it wasn't mentioned so far; outside of gnome.org, on the Python side of things, there exists the GTK+ 3 tutorial [0]

Re: Coordination for developer documentations

2014-03-05 Thread Stefan Sauer
On 03/04/2014 07:05 PM, Frederic Peters wrote: Hi Allan, Allan Day wrote: So, are you interested? It would help to know a bit more about what you think this coordination role would involve. Are you concerned with keeping technical changes in step, for example, or is it more the content in

Re: Coordination for developer documentations

2014-03-05 Thread Michael Hill
On Tue, Mar 4, 2014, at 10:54 AM, Jasper St. Pierre wrote: The issue seems to be that people show up, write a bunch of tutorials, docs, build a website, and then never finish it. They just leave and we're left with a half-finished developer docs site. It's been great seeing this happen at the

Re: Coordination for developer documentations

2014-03-05 Thread Sriram Ramkrishna
On Wed, Mar 5, 2014 at 2:20 PM, Michael Hill mdhil...@fastmail.fm wrote: On Tue, Mar 4, 2014, at 10:54 AM, Jasper St. Pierre wrote: The issue seems to be that people show up, write a bunch of tutorials, docs, build a website, and then never finish it. They just leave and we're left with a

Coordination for developer documentations

2014-03-04 Thread Frederic Peters
Hey, It's been proved again in recent hackfests, we have a really great team writing user documentations, and thanks have to be given to Shaun, and now Kat, for coordinating the effort. On the other hand we have absolutely no coordination for developer docs, I maintain developer.gnome.org with

Re: Coordination for developer documentations

2014-03-04 Thread Allan Day
Frederic Peters fpet...@gnome.org wrote: ... It's been proved again in recent hackfests, we have a really great team writing user documentations, and thanks have to be given to Shaun, and now Kat, for coordinating the effort. On the other hand we have absolutely no coordination for developer

Re: Coordination for developer documentations

2014-03-04 Thread Frederic Peters
Hi Allan, Allan Day wrote: So, are you interested? It would help to know a bit more about what you think this coordination role would involve. Are you concerned with keeping technical changes in step, for example, or is it more the content in our hand written documentation that we need to

Re: Coordination for developer documentations

2014-03-04 Thread Jasper St. Pierre
The issue seems to be that people show up, write a bunch of tutorials, docs, build a website, and then never finish it. They just leave and we're left with a half-finished developer docs site. Usually, the tutorials that these guys write end up not compiling or running in newer versions of the

Re: Coordination for developer documentations

2014-03-04 Thread Sriram Ramkrishna
On Tue, Mar 4, 2014 at 10:54 AM, Jasper St. Pierre jstpie...@mecheye.net wrote: The issue seems to be that people show up, write a bunch of tutorials, docs, build a website, and then never finish it. They just leave and we're left with a half-finished developer docs site. This is very true

Re: Coordination for developer documentations

2014-03-04 Thread Michael Ikey Doherty
On Tue, 2014-03-04 at 13:47 -0800, Sriram Ramkrishna wrote: On Tue, Mar 4, 2014 at 10:54 AM, Jasper St. Pierre jstpie...@mecheye.net wrote: The issue seems to be that people show up, write a bunch of tutorials, docs, build a website, and then never finish it. They just leave and we're left