pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
### Expected behavior `ForwardRef` wrappers to be removed from argument type annotations, as per 8702f62. ### Actual behavior For arguments, the wrapper is removed only if the entire type is...
Fixes https://github.com/pdoc3/pdoc/issues/319 The original method of finding submodules by recursing through the directory structure didn't work with extension modules (aka native "C" extensions) because there is no directory structure to...
Got a fatal exception on this line, which prevented the generation of the documentation. The problem is that some variable is initialized in a try bloc but still used out...
This shows "property" if a variable is a property with a setter and/or a deleter and "ro-property" (read only property) if it is a property which does not have either...
Dear @kernc, maintainers, For issue #110 I have implemented quite a dirty hack that adds the reSt `:param x:` and `:return:` directives replacing them with the Google-style docstring. This does...
One way to address https://github.com/pdoc3/pdoc/issues/99: adds a new `scanfilter` parameter that allows excluding specific submodules/sub trees. This also moves `_iter_modules` out of the method scope, which makes it monkey-patchable for...
### Expected Behavior method1 should display as method2 but with mark "Inherited from". ### Actual Behavior method1 of class test2 is not displayed. ### Steps to Reproduce 1. Clone https://github.com/MarshalX/pydoc_issue....
Documentation sources built with Sphinx, PyDoctor and others have tools like [doc2dash](https://github.com/hynek/doc2dash) intended to generate Dash docsets. It would be nice to have something that could generate dash docsets out...
I have successfully managed to build a documentation using pdoc3 for a project that can be represented as: ``` module/ ├── html └── module/ └── module.py ``` I am trying...
