pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
Hi there. I am trying to build the documentation for our package. It fails with either opening the development server or by trying to build the documention. I am doing...
Input: ``` from typing import Union def test1_func(arg: Union[None, str, int]) -> None: return ``` Resulting documentation: `def test1_func(arg: Union[ForwardRef(None), str, int]) ‑> None` Expected documentation: `def test1_func(arg: Union[None, str,...
I'm not sure whether this is a bug or simply I'm missing some configuration option, but if its the latter I can't find it so I apologise. I'm using the...
Pdoc by default ignores private classes/functions (names with a leading underscore) in a module from the documentation. However if a module consists entirely of private classes and functions, the submodule...
During a run of pdoc3, I was confronted with a python file with a comment containing non-utf8 characters. While this shouldn't have happened, pdoc3's current behavior is to raise an...
I would like to add the possibility of including files in the table of contents. As a first step we will focus only on including markdown files. In a next...
Adds support for nested classes to pdoc3. This is basically a newer version of angeloskath's commit 467350c12894e66d45151e274db79e2cb7df5906, https://github.com/pdoc3/pdoc/pull/176, but since I need support for nested classes, and the original merge...
### Expected Behavior Should work with Python 3.9. ### Actual Behavior Getting exception: ``` Traceback (most recent call last): File "/usr/local/bin/pdoc", line 8, in sys.exit(main()) File "/usr/local/lib/python3.9/site-packages/pdoc/cli.py", line 572, in...
The tests for the latest version (0.10.0) are failing on the [conda-forge feedstock](https://github.com/conda-forge/pdoc3-feedstock). See [here](https://github.com/conda-forge/pdoc3-feedstock/pull/11). One of the errors i see is [ModuleNotFoundError: No module named 'parser'](https://dev.azure.com/conda-forge/feedstock-builds/_build/results?buildId=480438&view=logs&jobId=656edd35-690f-5c53-9ba3-09c10d0bea97&j=656edd35-690f-5c53-9ba3-09c10d0bea97&t=e5c8ab1d-8ff9-5cae-b332-e15ae582ed2d). I think that...
### Expected Behavior Expected the type of the returned tuple to be noted as 'int' as in definition of the property. ### Actual Behavior Generated documentation notes that the returned...
