mitmproxy/pdoc

View on GitHub

API Documentation for Python Projects

Stars: 2.5k
Forks: 228
Open beginner issues: 0
Indexed issues: 53

Dominant language: Python
License: MIT-0
Last GitHub push: Apr 13, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: Code of conduct
Beginner labels: No beginner labels indexed
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

53 open issues indexed

Remove doctest directives from example blocks Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 65/100

mitmproxy/pdoc#899 · Opened Sep 4, 2026
Intersphinx inventory Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 55/100

mitmproxy/pdoc#898 · Opened Sep 1, 2026
Respect user's preferred browser Open

enhancement

Difficulty 2/5 1-3 hours Newbie friendliness 75/100

mitmproxy/pdoc#897 · 1 comment · Opened Aug 22, 2026
Add a configuration file (`pdoc.toml`) Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

mitmproxy/pdoc#878 · 5 comments · Opened Apr 7, 2026
Name resolution fails for binary lib +.pyi stubs Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#870 · 1 comment · Opened Feb 26, 2026
Infinite recursion when documenting PyO3 complex enums Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 48/100

mitmproxy/pdoc#868 · 3 comments · Opened Feb 14, 2026
pdoc is raising exception if using in project using pydantic v1 Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#864 · Opened Jan 14, 2026
pdoc treats overridden methods as inherited when mixing Generic[...] base class with non-generic ABC in multiple inheritance Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 48/100

mitmproxy/pdoc#862 · Opened Dec 27, 2025
Auto link to realized generics referenced in documentation Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#861 · 1 comment · Opened Dec 2, 2025
Not showing docs when PyO3 registers a struct with a different name Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 48/100

mitmproxy/pdoc#830 · 2 comments · Opened Sep 16, 2025
Option to add hyperlink third party libraries Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

mitmproxy/pdoc#825 · 2 comments · Opened Aug 29, 2025
Warning (and mildly inelegant output) from pdoc when using a type defined using a type alias Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 48/100

mitmproxy/pdoc#822 · Opened Jul 31, 2025
Defining a type alias referencing a type imported in a `TYPE_CHECKING` block causes `pdoc` to exit with a `NameError` on the imported type Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 55/100

mitmproxy/pdoc#821 · Opened Jul 31, 2025
Support custom descriptors as attributes Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#820 · Opened Jul 21, 2025
`subprocess.Popen` is documented as `pdoc.extract._PdocDefusedPopen` Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#819 · 1 comment · Opened Jul 8, 2025
External hyperlink produces garbled HTML when end of URL happens to overlap with name of identifier Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 66/100

mitmproxy/pdoc#817 · 2 comments · 2 reactions · Opened Jun 29, 2025
pdoc incorrectly orders references with numpy formatting Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#811 · 1 comment · Opened May 23, 2025
Incorrect documentation when a method and its return type share the same name Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 48/100

mitmproxy/pdoc#809 · 3 comments · Opened May 19, 2025
Trying to link to a nested module causes broken links Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 48/100

mitmproxy/pdoc#808 · 1 reaction · Opened May 17, 2025
Support default values specified in Pydantic Models Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#793 · 2 comments · 3 reactions · Opened Apr 2, 2025
Stub file information doesn't seem to be included from `_lib.pyi` Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#791 · 4 comments · Opened Mar 25, 2025
Don't show `dataclasses.InitVar` as a class member Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 50/100

mitmproxy/pdoc#790 · 2 comments · Opened Mar 22, 2025
Force display of method if defined in stub file Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 32/100

mitmproxy/pdoc#783 · 4 comments · Opened Mar 13, 2025
Way to explicitly shorten identifier in a docstring Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 45/100

mitmproxy/pdoc#782 · 1 comment · Opened Mar 13, 2025
Matrix with two rows appears smooshed into a single line Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#781 · 1 comment · Opened Mar 9, 2025
Apply Python syntax highlighting to all code blocks by default Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#776 · 1 comment · 1 reaction · Opened Feb 12, 2025
Mangled code block when using --docformat google Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#775 · 1 comment · Opened Feb 11, 2025
Submodule functions in __all__ get correctly hoisted to top-level docs, but not submodule variables Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#774 · 4 comments · Opened Feb 8, 2025
Can't combine math and custom filter Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#772 · Opened Jan 31, 2025
include local logo assets in pdoc output Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#766 · 1 comment · 3 reactions · Opened Dec 22, 2024
Forward references break with NamedTuples Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#765 · Opened Dec 22, 2024
PEP 695 syntax breaks parsing of forward type reference Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 42/100

mitmproxy/pdoc#762 · 2 comments · Opened Nov 24, 2024
Option to generate HTML as a single file Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#761 · Opened Nov 19, 2024
Ability to document submodules without runtime implications Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

mitmproxy/pdoc#757 · 3 comments · 1 reaction · Opened Nov 9, 2024
Support PEP 727 Annotated/Doc annotations? Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 35/100

mitmproxy/pdoc#755 · 3 comments · Opened Oct 26, 2024
`TYPE_CHECKING` warnings when subclassing `textual` objects Open

bug

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#695 · 7 comments · 1 reaction · Opened May 28, 2024
Proposal: Document each member at the lowest-level submodule, with higher level modules pointing at submodule's primary declaration without duplicating them. Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

mitmproxy/pdoc#679 · 2 comments · Opened Apr 10, 2024
Multiple reference duplication when loading docstring of function Open

bug upstream

Difficulty 4/5 3-5 days Newbie friendliness 25/100

mitmproxy/pdoc#660 · 2 comments · Opened Jan 11, 2024
Markdown emphasis captures before math does Open

bug upstream

Difficulty 4/5 3-5 days Newbie friendliness 30/100

mitmproxy/pdoc#639 · 2 comments · Opened Nov 20, 2023
Same `Headline` and Method Name Causes Identical HTML Anchors -> Cannot Jump to Method Documentation Anymore Open

bug upstream

Difficulty 3/5 1-2 days Newbie friendliness 38/100

mitmproxy/pdoc#497 · 1 comment · Opened Jan 20, 2023
reST: Support explicit titles for cross-references Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#472 · 6 comments · Opened Dec 16, 2022
Support for multiple versions of a package Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 20/100

mitmproxy/pdoc#470 · 9 comments · 3 reactions · Opened Dec 7, 2022
Exclude some files completely? Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#469 · 2 comments · Opened Dec 6, 2022
Extend Google list sections with more section types Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#466 · 2 comments · Opened Nov 17, 2022
Is there a way to determine if run/imported by pdoc at runtime? Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 25/100

mitmproxy/pdoc#449 · 9 comments · Opened Nov 4, 2022
Inline Math doesn't seem to support escapes with backslash Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 45/100

mitmproxy/pdoc#443 · 2 comments · Opened Sep 29, 2022
Support for typing @overload annotation Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#442 · 4 comments · Opened Sep 28, 2022
Homepage / page / bar with every function / class Open

enhancement

Difficulty 5/5 Over a week Newbie friendliness 32/100

mitmproxy/pdoc#432 · 2 comments · Opened Aug 25, 2022
Avoid expansion of typenames into long expressions, e.g., `numpy.typing.ArrayLike` Open

enhancement

Difficulty 4/5 3-5 days Newbie friendliness 35/100

mitmproxy/pdoc#420 · 13 comments · 8 reactions · Opened Jul 30, 2022
Improve handling of camelCase and snake_case when searching documentation Open

enhancement

Difficulty 3/5 1-2 days Newbie friendliness 35/100

mitmproxy/pdoc#412 · 2 comments · Opened Jul 11, 2022

mitmproxy/pdoc

Get new issues in your inbox