typedef output question/issue?

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi,

If I print a typedef in html (make htmldocs) from a .rst file,
I see:

type dma_cookie_t
    an opaque DMA cookie

Description

if dma_cookie_t is >0 it’s a DMA request cookie, <0 it’s an error code

~~~~~~~~~~~~~~~~~~~

If I print the same typedef in man format, it says 'typedef' instead of
'type', which is what I expect to see.

man formatted output:

Kernel API(9)                     API Manual                     Kernel API(9)

NAME
       typedef dma_cookie_t - an opaque DMA cookie

Description
       if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code

November 2024                    dma_cookie_t                    Kernel API(9)



I am using python311-Sphinx 8.0.2-1.2-noarch from openSUSE.

[internet search ...]

The $internet says that one option is to install and use:
Add 'sphinx_autodoc_typehints' to the extensions list in your conf.py file.
I tried that but now I get:
Extension error:
Unknown event name: autodoc-process-signature

Another option is to try a different theme so I reverted to
sphinx_rtd_theme but that didn't help either.

Does anyone know a good solution to this?

thanks.
-- 
~Randy




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux