Arch Linux

Please read this before reporting a bug:
https://wiki.archlinux.org/title/Bug_reporting_guidelines

Do NOT report bugs when a package is just outdated, or it is in the AUR. Use the 'flag out of date' link on the package page, or the Mailing List.

REPEAT: Do NOT report bugs for outdated packages!
Tasklist

FS#70081 - Add hints for opening gnome docs

Attached to Project: Arch Linux
Opened by champignoom (champignoom) - Friday, 19 March 2021, 20:39 GMT
Last edited by Balló György (City-busz) - Thursday, 08 June 2023, 23:25 GMT
Task Type Feature Request
Category Packages: Extra
Status Closed
Assigned To Jan Alexander Steffens (heftig)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 0
Private No

Details

Description:
After installing gtk-doc / gtkmm3-doc / glib2-docs / etc, nothing tells how to use them. One must dig out the locations of these htmls using pacman -Ql after digging out the usage of pacman itself.

Suggestions:
1. Add 'devhelp', the doc viewer for gnome libraries, as an optional dependency
2. or at least tell the user the exact location of the installed docs at the end of installation.
This task depends upon

Closed by  Balló György (City-busz)
Thursday, 08 June 2023, 23:25 GMT
Reason for closing:  Not a bug
Comment by Balló György (City-busz) - Thursday, 08 June 2023, 23:25 GMT
All developer documentation is installed below /usr/share/gtk-doc/, it's easy to find I think. devhelp is just one tool, but you can use any web browser to open the html files. And we have a section for API documentation browsers in the wiki:
https://wiki.archlinux.org/title/List_of_applications/Utilities#API_documentation_browsers

I think it's enough, but the wiki can be always improved.

Loading...