pdoc

pdoc copied to clipboard

Types with nested "|" (Union) are not formatted well

5

For this program: ``` from __future__ import annotations from typing import Iterable def function1(value: int | str = 1) -> None: pass def function2(value: int | str | Iterable[int |...

hhoppe

one of the pytest doctests in a docstring not rendered correctly

2

#### Problem Description One of the doctests in the example below isn´t rendered correctly. The behavior depends on indentation and on the --docformat command argument: see example below. #### Steps...

tmeyier

rendering of markdown gives bad result

1

#### Problem Description rendering of markdown gives bad result if it contains headings, a fenced code block and some specific html #### Steps to reproduce the behavior: test script: markdown_test.py...

tmeyier

Avoid expansion of typenames into long expressions, e.g., `numpy.typing.ArrayLike`

13

Packages often include typenames that expand to long `Union[...]` definitions. Examples include `ArrayLike` and `DTypeLike` from `numpy.typing` (see [here](https://numpy.org/devdocs/reference/typing.html#numpy.typing.ArrayLike)) For this sample program ```python from typing import Any import numpy...

hhoppe

Improve handling of camelCase and snake_case when searching documentation

2

#### Problem Description When I am searching for the documentation for a function, say `fooBarFunction()`, I will often type `foo bar function` into the search box in order to save...

MaddyGuthridge

Dataclass member documentation issues

4

#### Problem Description When using the `@dataclass` decorator from the `dataclasses` module, pdoc seems to think that member (instance) variables with default values are actually class variables. Furthermore, when using...

JCGoran

Support Epytext docstring syntax (`@param`)

7

#### Problem Description As noted in #143 , many Python projects use the format `:param : ` or `@param : `, but this format for documenting function parameters is not...

thehale

Improve Rendering of `typing.TypeVar`

9

#### Problem Description TypeVars seem to be simply put through `repr` to get their textual format. TypeVar's `__repr__` is missing important information necessary to the use of the class including...

ktbarrett

Support embedding local images (through reST directives)

3

#### Problem Description First of all, it's great to see this package being developed again! I've only just begun converting my docstrings into external documentation and this looks like it...

StellarStorm

Markdown Export

10

hey any chance we can create a ticket for the markdown output support? I saw there is one that was closed but the markdown branch is over a hundred commits...

mhils