FS#79707 - [neovim] add pacman hook for generating documentation helptags

Attached to Project: Arch Linux
Opened by Damien Tardy-Panis (tardypad) - Saturday, 16 September 2023, 10:42 GMT
Last edited by Buggy McBugFace (bugbot) - Saturday, 25 November 2023, 20:26 GMT
Task Type Feature Request
Category Packages: Extra
Status Closed
Assigned To Sven-Hendrik Haase (Svenstaro)
Caleb Maclennan (alerque)
Daniel M. Capella (polyzen)
Architecture All
Severity Low
Priority Normal
Reported Version
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Votes 1
Private No

Details

Similarly to the vim package, it would be nice to have a pacman hook to regenerate the documentation that are added when installing neovim plugins.

See https://gitlab.archlinux.org/archlinux/packaging/packages/vim/-/blob/main/vimdoc.hook and  FS#51591 
This task depends upon

Closed by  Buggy McBugFace (bugbot)
Saturday, 25 November 2023, 20:26 GMT
Reason for closing:  Moved
Additional comments about closing:  https://gitlab.archlinux.org/archlinux/p ackaging/packages/neovim/issues/2
Comment by Toolybird (Toolybird) - Saturday, 16 September 2023, 21:59 GMT
Related  FS#78657 
Comment by Caleb Maclennan (alerque) - Tuesday, 10 October 2023, 11:41 GMT
I implemented this in 0.9.4-2, but I stuck it in testing because I couldn't confirm it was right. No plugins packages that I see actually install anything in the neovim documentation directory (or at least the one I was expecting). Do we have any examples of plugin packages for which this is relevant and can be tested?
Comment by Damien Tardy-Panis (tardypad) - Tuesday, 10 October 2023, 11:53 GMT
In the official repos, I see https://archlinux.org/packages/extra/any/neovim-lspconfig/ and https://archlinux.org/packages/extra/any/neovim-lsp_signature/ as examples which have a doc file
Comment by Caleb Maclennan (alerque) - Thursday, 12 October 2023, 10:22 GMT
@tardypad Those packages install to a site specific pack directory. Is there a `:helptags` path we should be calling for that? Does it recurse if we just globally call it on `:helptags /usr/share/nvim/site/`?
Comment by Damien Tardy-Panis (tardypad) - Thursday, 12 October 2023, 10:39 GMT
To make it simpler you could just run `:helptags ALL` to cover all cases
Per the documentation, "all doc directories in 'runtimepath' will be used."

Loading...