Pick up docstrings from pyi files

[benruijl]

I have a .pyi file that looks like this:

"""
Symbolica Python API.
"""

from __future__ import annotations
from typing import Callable, overload, Iterator, Optional, Sequence, Tuple, List


class Expression:
    """A Symbolica expression."""

    def var(_cls, name: str) -> Expression:
        """
        Creates a Symbolica expression that is a single variable.

        Examples
        --------
        >>> var_x = Expression.var('x')
        >>> print(var_x)
        x
        """

    @classmethod
    def vars(_cls, *names: str) -> Sequence[Expression]:
        """
        Create a Symbolica variable for every name in `*names`.
        """

    @classmethod
    def fun(_cls, name: str, is_symmetric: bool = False) -> Function:
        """
        Creates a new Symbolica function with a given name.

        Examples
        --------
        >>> f = Expression.fun('f')
        >>> e = f(1,2)
        >>> print(e)
        f(1,2)
        """

    @classmethod
    def funs(_cls, *names: str) -> Sequence[Function]:
        """
        Create a Symbolica function for every name in `*names`.
        """

    @classmethod
    def parse(_cls, input: str) -> Expression:
        """
        Parse a Symbolica expression from a string.

        Parameters
        ----------
        input: str
            An input string. UTF-8 character are allowed.

        Examples
        --------
        >>> e = Expression.parse('x^2+y+y*4')
        >>> print(e)
        x^2+5*y

        Raises
        ------
        ValueError
            If the input is not a valid Symbolica expression.
        """

    def __copy__(self) -> Expression:
        """
        Copy the expression.
        """

With many more entries. When generating the pdoc output for this using either:

 python -m pdoc ./symbolica.pyi

or

python -m pdoc ./symbolica.so

I get

The output is missing some functions, such as __copy__, and is missing most documentation. For some reason, some functions do contain documentation.

VS Code has no problems showing the documentation:

Do you have any idea what is going on?

[mhils]

We currently only copy over annotations from pyi files, but I agree that docstrings would be super useful as well!

The right place to do this is at https://github.com/mitmproxy/pdoc/blob/v14.0.0/pdoc/doc_pyi.py#L58, contributions are welcome! :)