Re: documenting my own plugins?

On 2023-06-10, Jose Caballero wrote:
> Hi,
> apologies if this is a silly question.
>
>
> I am trying to write documentation for my plugins in the ~/.vim/ftplugin/foo/
> directory.
> This is what I have tried:
>
> 1) created  ~/.vim/ftplugin/foo/doc/
> 2) created file ~/.vim/ftplugin/foo/doc/testfoo.txt with content
>
> *testfoo* this is a test
>
> 3) :helptags ~/.vim/ftplugin/foo/
> 4) But when I try 
>
> :help testfoo 
>
> it doesn't work.
>
> What am I missing?

I don't know for sure--I haven't tested this--but ":help
add-local-help" uses as an example,

:helptags ~/.vim/doc

Note that that path ends with the doc directory. So try this:

:helptags ~/.vim/ftplugin/foo/doc

HTH,
Gary

--
--
You received this message from the "vim_use" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

---
You received this message because you are subscribed to the Google Groups "vim_use" group.
To unsubscribe from this group and stop receiving emails from it, send an email to vim_use+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/vim_use/20230610175109.GA21417%40phoenix.