Show documentation on (neovim) floating window?

Hello, Do you have a plan to implement show doc on (nvim) floating window? Like vim-go has a setting called g:go_doc_popup_window. Show doc on Floating window or Popup window may be more comfortable than preview~

Thanks.

[blayz3r]

In the mean time I am using this hack:

autocmd FileType python nnoremap <buffer> K :call PyDocVim()<CR>

function! PyDocVim()
python3 << EOF
import jedi

curfile = vim.current.buffer.name
row = vim.current.window.cursor[0]
col= vim.current.window.cursor[1]

script = jedi.Script(
    source=None,
    path=curfile,
    line=row,
    column=col)

try:
    definitions = script.goto_definitions()
except Exception:
    # print to stdout, will be in :messages
    definitions = []
    print("Exception, this shouldn't happen.")
    print(traceback.format_exc())

    if not definitions:
        echo_highlight("No documentation found for that.")
        vim.command("return")

docs = []
for d in definitions:
    doc = d.docstring()
    if doc:
        title = "Docstring for %s" % d.desc_with_module
        underline = "=" * len(title)
        docs.append("%s\n%s\n%s" % (title, underline, doc))
    else:
        docs.append("|No Docstring for %s|" % d)
    text = ("\n" + "-" * 79 + "\n").join(docs)
vim.command("let docWidth = %s" % len(title))
vim.command("let doc_lines = %s" % len(text.split("\n")))
EOF
    "Scroll
    function! s:popup_filter(winid, key)
        if a:key ==# "\<c-k>"
            call win_execute(a:winid, "normal! \<c-y>")
            return v:true
        elseif a:key ==# "\<c-j>"
            call win_execute(a:winid, "normal! \<c-e>")
            return v:true
        elseif a:key ==# 'q' || a:key ==# 'x'
            return popup_filter_menu(a:winid, 'x')
        endif
        return v:false
    endfunction

    let lines = py3eval('text')
    let winid = popup_create(lines->split('\n'), #{
            \ filter: function('s:popup_filter'),
            \ pos: 'botleft',
            \ line: 'cursor-1',
            \ col: 'cursor',
            \ moved: 'any',
            \ border: [1,1,1,1,1,1,1,1],
            \ borderchars: ['─', '│', '─', '│', '┌', '┐', '┘', '└'],
            \ borderhighlight: ['Todo'],    
            \ padding: [0,1,0,1],
            \ firstline: 1,
            \ scrollbar: 1,
            \ minwidth: docWidth,
            \ maxwidth: 74,
            \ minheight: doc_lines,
            \ maxheight: 20,
            \ mapping: 0,
            \ })

    call setbufvar(winbufnr(winid), '&syntax','rst')
    call setwinvar(winid, '&wincolor', 'Normal')
endfunction

[BrunoGomesCoelho]

Thank you very much, that was indeed the problem!

I also had to change title = "Docstring for %s" % d.desc_with_module to title = "Docstring for %s" % d.full_name to make it work;

I added a line for color support in neovim since it didn’t have any color syntaxing without: call setbufvar(winbufnr(winid), '&syntax','rst')

Here's my current full code for nvim if useful

"----- show documentation in floaterm window from https://github.com/neovim/neovim/issues/1004
if has('nvim')
	autocmd FileType python nnoremap <buffer> K :call PyDocVim()<CR>

   function! PyDocVim()
python3 << EOF
import jedi

curfile = vim.current.buffer.name
row = vim.current.window.cursor[0]
col= vim.current.window.cursor[1]

script = jedi.Script(
    code=None,
    path=curfile)

try:
   definitions = script.help(line=row, column=col)
   # definitions = script.goto_definitions()
except Exception:
   # print to stdout, will be in :messages
   definitions = []
   print("Exception, this shouldn't happen.")
   print(traceback.format_exc())

   if not definitions:
	   echo_highlight("No documentation found for that.")
	   vim.command("return")

docs = []
for d in definitions:
   doc = d.docstring()
   if doc:
	   title = "Docstring for %s" % d.full_name
	   underline = "=" * len(title)
	   docs.append("%s\n%s\n%s" % (title, underline, doc))
   else:
	   docs.append("|No Docstring for %s|" % d)
   text = ("\n" + "-" * 79 + "\n").join(docs)
vim.command("let docWidth = %s" % len(title))
vim.command("let doc_lines = %s" % len(text.split("\n")))
EOF
	   "Scroll
	   function! s:popup_filter(winid, key)
		   if a:key ==# "\<c-k>"
			   call win_execute(a:winid, "normal! \<c-y>")
			   return v:true
		   elseif a:key ==# "\<c-j>"
			   call win_execute(a:winid, "normal! \<c-e>")
			   return v:true
		   elseif a:key ==# 'q' || a:key ==# 'x'
			   return popup_filter_menu(a:winid, 'x')
		   endif
		   return v:false
	   endfunction

	   let $FZF_DEFAULT_OPTS .= ' --border --margin=0,2'
	   let width = float2nr(&columns * 0.9)
	   let height = float2nr(&lines * 0.6)
	   let opts = { 'relative': 'editor',
				  \ 'row': (&lines - height) / 2,
				  \ 'col': (&columns - width) / 2,
				  \ 'width': width,
				  \ 'height': height }


	   let buf = nvim_create_buf(v:false, v:true)
	   let lines = py3eval('text')
	   call nvim_buf_set_lines(buf, 0, -1, v:true, split(lines, '\n'))
	   let winid = nvim_open_win(buf, v:true, opts)
	   " call setwinvar(winid, '&wincolor', 'Normal')
	    call setbufvar(winbufnr(winid), '&syntax','rst')
	   call setwinvar(winid, '&winhighlight', 'NormalFloat:Normal')
	endfunction
endif