pdoc3/pdoc

View on GitHub

🐍 ➡️ 📜 Auto-generate API docs for Python projects

Stars: 1.2k
Forks: 146
Open beginner issues: 0
Indexed issues: 98

Dominant language: Python
License: AGPL-3.0
Last GitHub push: Aug 15, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: No code of conduct
Beginner labels: good first issue hacktoberfest
PR merge metrics: No merged PRs in 30d

Beginner friendly Everything

Open All

98 open issues indexed

New pybind11 type hints break signature parsing from doc string Open

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

pdoc3/pdoc#476 · Opened Aug 16, 2026
return annotations for C-buildins (pybind11) are ignored Open

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

pdoc3/pdoc#474 · Opened Aug 15, 2026
Questions about usage in case of AGPL license Open

question

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

pdoc3/pdoc#472 · 4 comments · Opened Jul 25, 2026
Types and type aliases not included in documentation output Open

enhancement

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

pdoc3/pdoc#466 · 2 comments · 1 reaction · Opened Dec 4, 2025
TypeError on namespace package while working in server mode Open

bug

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

pdoc3/pdoc#461 · Opened Jul 2, 2025
Documentation should be generated with `typing.TYPE_CHECKING == True` Open

bug

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

pdoc3/pdoc#460 · 2 comments · 1 reaction · Opened Jul 1, 2025
RuntimeError: absolute path '.../dataclasses.py' is not a descendant of the current working directory or of the system's python library Open

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

pdoc3/pdoc#456 · 1 comment · 1 reaction · Opened Feb 23, 2025
submodule containing a function or class of the same name as the submodule won't be identified Open

bug

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

pdoc3/pdoc#452 · Opened Aug 19, 2024
Make it possible to ignore class members based on wildcard strings Open

enhancement

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

pdoc3/pdoc#449 · 2 comments · Opened Aug 1, 2024
Add GitHub Flavor Markdown support Open

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

pdoc3/pdoc#433 · 2 comments · 1 reaction · Opened Dec 7, 2023
missing docstrings of methods Open

bug help wanted 🤷

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

pdoc3/pdoc#426 · 4 comments · Opened Jul 5, 2023
Include html containing javascript Open

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

pdoc3/pdoc#423 · Opened Jun 5, 2023
Support for headings to organize functions into sections Open

enhancement

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

pdoc3/pdoc#422 · 1 comment · 1 reaction · Opened May 5, 2023
Upgrade code reference warnings to errors. Open

bug enhancement good first issue Hacktoberfest help wanted 🤷

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

pdoc3/pdoc#420 · 1 comment · 2 reactions · Opened Feb 10, 2023
PEP224 style docstring not honoured for global variable of type Callable Open

bug

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

pdoc3/pdoc#418 · Opened Jan 11, 2023
Strike Through Markdown not working Open

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

pdoc3/pdoc#417 · Opened Dec 15, 2022
Wrong search hyperlinks to page sections for inherited classes Open

bug

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

pdoc3/pdoc#416 · 1 comment · Opened Dec 11, 2022
Error if an extensition has been compiled for several python version. Open

bug

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

pdoc3/pdoc#407 · 6 comments · Opened Jul 21, 2022
Request: Add option to generate `.pyi` stub files Open

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

pdoc3/pdoc#405 · 1 reaction · Opened Jun 22, 2022
Inner classes are showing as class variables Open

enhancement

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

pdoc3/pdoc#404 · 1 reaction · Opened Jun 22, 2022
conda-forge tests failing Open

bug

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

pdoc3/pdoc#393 · 1 comment · 2 reactions · Opened Apr 11, 2022
pdoc3 doesn't use the latest version of the python file Open

help wanted 🤷

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

pdoc3/pdoc#381 · 1 comment · Opened Jan 19, 2022
pdoc3 programmatic-usage example Open

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

pdoc3/pdoc#377 · Opened Dec 29, 2021
enable showing private methods/variables Open

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

pdoc3/pdoc#375 · 2 comments · 1 reaction · Opened Dec 29, 2021
Exclude empty submodule from docs Open

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

pdoc3/pdoc#374 · 1 comment · Opened Dec 21, 2021
documentation root folder and links to child pages Open

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

pdoc3/pdoc#373 · 1 comment · Opened Dec 16, 2021
Introduce option for hljs-meta tags to not be user-selectable. Open

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

pdoc3/pdoc#372 · 3 comments · 1 reaction · Opened Dec 15, 2021
Can you publish a wheel as well as the sdist? Open

enhancement

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

pdoc3/pdoc#370 · 2 comments · Opened Dec 5, 2021
Linking stops working with "from __future__ import annotations" Open

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

pdoc3/pdoc#369 · 2 reactions · Opened Nov 29, 2021
Collection of "community" themes and templates Open

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

pdoc3/pdoc#365 · 1 comment · 1 reaction · Opened Oct 27, 2021
pdoc3 with submodules spread across various directories Open

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

pdoc3/pdoc#364 · 1 comment · Opened Oct 23, 2021
Pdoc fails if a base class uses a NotImplementedError Open

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

pdoc3/pdoc#353 · Opened Aug 22, 2021
Allow detection of pdoc3 execution Open

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

pdoc3/pdoc#347 · 1 reaction · Opened Jul 3, 2021
Using multiple return values in Google-style docstrings Open

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

pdoc3/pdoc#345 · Opened Jun 22, 2021
Support for dynamically hiding or showing modules Open

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

pdoc3/pdoc#344 · Opened Jun 13, 2021
Exception when a type hint is a torch.tensor Open

bug

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

pdoc3/pdoc#342 · 3 comments · 2 reactions · Opened May 14, 2021
The idea for documenting reimported entities from submodules Open

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

pdoc3/pdoc#340 · 5 comments · Opened May 9, 2021
localhost:8080 loads forever Open

bug

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

pdoc3/pdoc#339 · 4 comments · Opened May 6, 2021
Custom attributes to HTML templates Open

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

pdoc3/pdoc#335 · 4 comments · Opened Apr 14, 2021
html files with underscores in names aren't shown in github pages Open

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

pdoc3/pdoc#334 · 2 comments · Opened Apr 10, 2021
Type hints for custom objects not linked Open

bug

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

pdoc3/pdoc#333 · 1 comment · Opened Apr 9, 2021
Methods not showing up in PDOC3 html. Open

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

pdoc3/pdoc#330 · Opened Mar 24, 2021
search always gives no results Open

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

pdoc3/pdoc#328 · 8 comments · Opened Mar 24, 2021
ForwardRef not unwrapped for inner quoted types in arguments Open

bug

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

pdoc3/pdoc#327 · 1 reaction · Opened Mar 23, 2021
Use updated argspecs of functions wrapped by signature-changing decorators Open

enhancement

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

pdoc3/pdoc#326 · 1 reaction · Opened Mar 23, 2021
show_inherited_members doesn't work for empty docstring Open

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

pdoc3/pdoc#322 · Opened Mar 11, 2021
Creating an example gallery using pdoc3 Open

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

pdoc3/pdoc#320 · 1 comment · Opened Mar 2, 2021
Submodules not showing up for (native) extension modules Open

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

pdoc3/pdoc#319 · 6 comments · 1 reaction · Opened Mar 2, 2021
Unable to build documentation for Django project Open

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

pdoc3/pdoc#314 · 13 comments · 2 reactions · Opened Feb 19, 2021
pre-commit hook usage with virtualenv fails Open

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

pdoc3/pdoc#313 · 4 comments · Opened Feb 19, 2021

pdoc3/pdoc

Get new issues in your inbox