pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
### Expected behavior I can document classes that include mock object members (for example, when documenting testing utilities). ### Actual behavior Traceback ``` Traceback (most recent call last): File "/usr/bin/pdoc",...
Take the following script saved in `bug.py`: ``` import torch def no_likey(input: torch.tensor): pass ``` Now execute `pdoc --html bug.py`. An exception is raised: ``` Traceback (most recent call last):...
Python 3 allows Unicode identifiers, so non-ASCII characters should be handled with care. This commit fixes a bug that only happens when serving with `--http` (works fine when generating static...
## Feature request Allow detection of pdoc3 being executed, e.g. allowing for customizing module paths etc. on pdoc3 runtime. For example through setting an environment variable that can be checked...
I understand that this is not related to pdoc3, but it does relate to the pdoc3 docs page. I also know that some people will jump on and accuse me...
How pdoc deals with multiple return values in Google-style docstrings. What are the best practices [for this scenario](https://github.com/sphinx-doc/sphinx/issues/9119)? I have tried [version 3](https://github.com/sphinx-doc/sphinx/issues/9119#issue-862617296), but the rendered html returns section does...
I currently use pdoc3 for my "developer documentation", i.e. the reference developers using my library goes to. That's a specific subset of all the modules I ship. Now, I would...
I'm a bit surprised that instance variables aren't automatically picked up if they don't have docstrings. Property methods without docstrings are listed, I'd expect regular instance variables to show up...
### Expected Behavior When using `-c show_types_annotations` (found in #6), hyperlinks to external references should be added not only on the method declaration but also in the doc below (that...
