pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
### Expected Behavior - pdoc3 at least loads up a the top-lv documentation on localhost ### Actual Behavior - localhost:8080 loads forever ### Steps to Reproduce 1.run ` pdoc --template-dir...
PyDoc is wonderful! I had it up and running in minutes, and it produced beautiful docs. But I hit an issue. We would like to use this both for docs...
I would like to append the documentation with auxiliary data which would be collected at the time of document generation. (eg. test results). ### Expected Behavior When using `pdoc3` programmatically,...
The solution related in this [issue](https://github.com/TypeStrong/typedoc/issues/648) resolves the problem
### Expected Behavior File called `20210409_pdoc.py` ``` class Child: def __init__(self, name: str ="child"): """ One child description Args: name: name of child """ self.name: str = name class Parent:...
When running `pdoc` on an extension modules (aka, a native "C" extensions), the extension module's submodules don't show up in the documentation even though <TAB>-autocomplete in a Python REPL can...
### Expected Behavior After running pre-commit hook, to have generated pdoc output in the directory ### Actual Behavior ModuleNotFoundError is raised when running the pdoc pre-commit hook ### Steps to...
### Expected Behavior I am generating PDOC for my api as a temporary solution for my documentation and it's supposed to include all methods in a test package and their...
### Actual behavior When applying decorators that change the argument spec, internally applying `functools.wraps` to the replacement causes the corresponding docs to show the arguments of the inner wrapped function,...
