Re: Gtk-Doc Manual in DevHelp
Hello, Just a quick opinion on this below... On Sat, 11 Aug 2018 13:02:31 +0200, Christoph Reiter via desktop-devel-list wrote: > On Sat, Aug 11, 2018 at 12:28 PM, Lanoxx wrote: > > Hi All, > > > > It would be nice if I could get some response about my question from the > > community. I spend several days of work on this and I would like to know if > > there is a change that my patch gets merged into Gtk-Doc. I am restating my > > question in case it was not clear from my original mail what I was asking: > > It's probably best if you create a new gtk-doc merge request with this > change as in the end the gtk-doc maintainers have to decide. > > > Does anybody have objections on merging my patch which installs the GTK-Doc > > Manual as HTML so it can be read via DevHelp? > > I haven't looked at the patch, but having the manual in devhelp seems > good to me. As a matter of fact, I used to not be 100% sure whether a Gtk-Doc manual existed. I kinda imagined it would, but because it doesn't appear in Devhelp I never bothered to really go and read it (usually one can get pretty far along with looking at how the surrounding code is documented when making changes to existing projects...). All in all, it looks to me like the Gtk-Doc manual should definitely be available in Devhelp. The GNOME user guide is for end users, while Devhelp is for developers and where developer-oriented documentation belongs. Cheers, -Adrián pgpwx1aTXHLum.pgp Description: PGP signature ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Gtk-Doc Manual in DevHelp
On Sat, Aug 11, 2018 at 12:28 PM, Lanoxx wrote: > Hi All, > > It would be nice if I could get some response about my question from the > community. I spend several days of work on this and I would like to know if > there is a change that my patch gets merged into Gtk-Doc. I am restating my > question in case it was not clear from my original mail what I was asking: It's probably best if you create a new gtk-doc merge request with this change as in the end the gtk-doc maintainers have to decide. > Does anybody have objections on merging my patch which installs the GTK-Doc > Manual as HTML so it can be read via DevHelp? I haven't looked at the patch, but having the manual in devhelp seems good to me. ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Gtk-Doc Manual in DevHelp
Hi All, It would be nice if I could get some response about my question from the community. I spend several days of work on this and I would like to know if there is a change that my patch gets merged into Gtk-Doc. I am restating my question in case it was not clear from my original mail what I was asking: Does anybody have objections on merging my patch which installs the GTK-Doc Manual as HTML so it can be read via DevHelp? If the patch needs more work I would like to know it soon so I can stop thinking about it and focus on other things. I have two weeks holidays now and could spend some more time on this in the next days. If the patch is rejected I would like to know why. Thank in advance Sebastian On 09/08/18 08:01, Sebastian Geiger wrote: Hi Bastien, In this case gitlab is misleading. Stefan accidentally merged my whole branch and later reverted this specific commit. So my question still stands. Cheers Sebastian On 8. Aug 2018, at 16:17, Bastien Nocera wrote: On Fri, 2018-08-03 at 09:03 +0200, Sebastian Geiger (Lanoxx) wrote: Hi all, I have tested my patch and I can view the GTK-Doc Manual in DevHelp. I would be very happy if this change could be merged into Gtk-Doc. Sorry, but I don't quite understand what you're asking of the wider community. The patch was merged in this MR: https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/3 Was there anything else that needed happen? [1]: https://developer.gnome.org/gtk-doc-manual/ [2]: https://gitlab.gnome.org/GNOME/gtk-doc/commit/ffd5f97ed73a670f1b 7687d9a39e80f5f7941332 ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Gtk-Doc Manual in DevHelp
Hi Bastien, In this case gitlab is misleading. Stefan accidentally merged my whole branch and later reverted this specific commit. So my question still stands. Cheers Sebastian > On 8. Aug 2018, at 16:17, Bastien Nocera wrote: > >> On Fri, 2018-08-03 at 09:03 +0200, Sebastian Geiger (Lanoxx) wrote: >> Hi all, >> > >> I have tested my patch and I can view the GTK-Doc Manual in DevHelp. >> I >> would be very happy if this change could be merged into Gtk-Doc. > > Sorry, but I don't quite understand what you're asking of the wider > community. The patch was merged in this MR: > https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/3 > > Was there anything else that needed happen? > >> [1]: https://developer.gnome.org/gtk-doc-manual/ >> >> [2]: https://gitlab.gnome.org/GNOME/gtk-doc/commit/ffd5f97ed73a670f1b >> 7687d9a39e80f5f7941332 >> >> ___ >> desktop-devel-list mailing list >> desktop-devel-list@gnome.org >> https://mail.gnome.org/mailman/listinfo/desktop-devel-list ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
Re: Gtk-Doc Manual in DevHelp
On Fri, 2018-08-03 at 09:03 +0200, Sebastian Geiger (Lanoxx) wrote: > Hi all, > > I have tested my patch and I can view the GTK-Doc Manual in DevHelp. > I > would be very happy if this change could be merged into Gtk-Doc. Sorry, but I don't quite understand what you're asking of the wider community. The patch was merged in this MR: https://gitlab.gnome.org/GNOME/gtk-doc/merge_requests/3 Was there anything else that needed happen? > [1]: https://developer.gnome.org/gtk-doc-manual/ > > [2]: https://gitlab.gnome.org/GNOME/gtk-doc/commit/ffd5f97ed73a670f1b > 7687d9a39e80f5f7941332 > > ___ > desktop-devel-list mailing list > desktop-devel-list@gnome.org > https://mail.gnome.org/mailman/listinfo/desktop-devel-list ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
Gtk-Doc Manual in DevHelp
Hi all, I would like to discuss a proposal for bringing the Gtk-Doc Manual into DevHelp. At the moment the Gtk-Doc manual can be read online at developer.gnome.org [1] and by using yelp. I think yelp is not as useful as devhelp for several reasons. The representation is different than in devhelp, some cross references in the document do not work properly and there is also no table of contents like devhelp has. While these are my personal preferences of course I think it would do no harm to provide the manual for DevHelp in addition to yelp. I have already prepared patches for installing the Gtk-Doc Manual as HTML files with DevHelp support. The patches can be found at [2]. I asked Stefan Sauer the maintainer of Gtk-Doc about merging my patches but he suggested to have discussion about this change on the mailing list first. So my question is whether other GNOME developers would find it useful to have the GTK-Doc manual in DevHelp? I argue, that since the main target group of Gtk-Doc are developers and not end-users Devhelp would be a better fit. This way develpers can find all their documentation at one place (e.g. devhelp) and do not need to keep two tools open. I would also like to point out that for a long time I was not aware that the Gtk-Doc manual was available via yelp since the list of help documents is pretty well hidden. I first thought that yelp only showed the Ubuntu Documentation until I found that via Hamburger Menu -> All Help one can access additional manuals. My patch adds xsltproc to gtk-doc for generating HTML files from the Gtk-Doc Manual and then uses an install hook to install the html files and copy the Gtk-Doc stylesheets to $(datadir)/gtk-doc/html/$(HELP_ID). I have tested my patch and I can view the GTK-Doc Manual in DevHelp. I would be very happy if this change could be merged into Gtk-Doc. Best Regards Sebastian [1]: https://developer.gnome.org/gtk-doc-manual/ [2]: https://gitlab.gnome.org/GNOME/gtk-doc/commit/ffd5f97ed73a670f1b7687d9a39e80f5f7941332 ___ desktop-devel-list mailing list desktop-devel-list@gnome.org https://mail.gnome.org/mailman/listinfo/desktop-devel-list
