pdoc

pdoc copied to clipboard

add pre-commit support

1

#### Problem Description Need to get this working with pre-commit #### Proposal create a .pre-commit-config.yaml file on root dir, fill it in with required config, you can use [this](https://github.com/pdoc3/pdoc/blob/master/.pre-commit-hooks.yaml) as...

MstWntd

Support `start-after` option for `.. include::` directive

1

#### Problem Description I want to include my README in the index of my API docs, but this results in a duplicate top-level heading as the README has its own...

frankharkins

Proposal: Document each member at the lowest-level submodule, with higher level modules pointing at submodule's primary declaration without duplicating them.

2

#### Problem Description I want to be able to import classes and functions to higher level modules, for developer convenience, but without insane redundancies in where classes are defined. In...

aaronsteers

Error parsing annotation: 'type' object is not subscriptable

2

#### Problem Description I receive the following warning when working with certain tkinter event annotations. In addition, the type hinting is tagged in the html as a string, and has...

staceybellerose

TypeError in /pdoc/extract.py

2

#### Problem Description When running pdoc, i get a TypeError. I cannot figure out if this is a bug in pdoc or if it is a problem with my project,...

pnjun

Error importing module: no signature found for builtin type `<class 'type I wrote'>`

3

#### Problem Description When attempting to use `pdoc` on [my package](https://github.com/JesseTG/libretro.py), I get a stack trace similar to the following when trying to view the doc page for any module:...

JesseTG

Bumps the dependencies group with 12 updates: | Package | From | To | | --- | --- | --- | | [coverage[toml]](https://github.com/nedbat/coveragepy) | `7.5.3` | `7.5.4` | | [filelock](https://github.com/tox-dev/py-filelock)...

dependabot[bot]

Arbitrary documentation is generated for undocumented enum, with python 3.12

1

Hi, With an undocumented enum like this ``` from enum import Enum class MyEnum(Enum): one = 1, two = 2 ``` pdoc 14.5.0 with python 3.12 generates html with some...

mfrigerio17

Embedded local images not working when inside __init__

7

#### Problem Description With #460 the embedding of images was added. However, the suggested usage of `` does not work for me. I am adding my README to the `__doc__`...

HackXIt

`TYPE_CHECKING` warnings when subclassing `textual` objects

7

#### Problem Description I am seeing the same problem reported in #648 but when dealing with classes from the [`textual`](https://github.com/Textualize/textual) package. I am using the latest pdoc (14.5.0) so the...

mrossinek