pdoc
pdoc copied to clipboard
pdoc3
:snake: :arrow_right: :scroll: Auto-generate API documentation for Python projects
### Expected Behavior I am documenting a package containing fortran extension build with f2py/gfortran/gcc on linux. Once the package is installed the root folder contains `mypkg.cpython-39-x86_64-linux-gnu.so` which is imported in...
I have the following code using a type alias (https://docs.python.org/3/library/typing.html#type-aliases): ```python3 from typing import Callable MyType = Callable[[str], str] """My function type""" ``` ### Expected Behavior I would expect to...
Hi I was searching for some typing inspection tools and found none that can both generate a python stub file (`.pyi`) and use the data from the runtime. This is...
### Expected Behavior I would expect an inner class to document similarly to an outer class. ### Actual Behavior The class gets documented as a class variable. ### Steps to...
### Expected Behavior I am trying to build documentation that would show the function and the variables contained in that function in the rendered documentation. so with this function `def...
### Expected Behavior The search should return a list of results. ### Actual Behavior The search always returns `No results.` ### Steps to Reproduce 1. Generate docs with a `config.mako`...
Apparently distutils is getting deprecated in Python 3.12. For more details see [PEP-632](https://peps.python.org/pep-0632/) ### Expected Behavior Not getting spammed with deprecation warnings. ### Actual Behavior I see some deprecation warnings....
The following test fails on Python 3.10: ``` ====================================================================== FAIL: test_text (pdoc.test.CliTest) (package='example_pkg') ---------------------------------------------------------------------- Traceback (most recent call last): File "/private/tmp/nix-build-python3.10-pdoc3-0.10.0.drv-0/pdoc3-0.10.0/pdoc/test/__init__.py", line 372, in test_text self.assertNotIn(pattern, out) AssertionError: 'non_callable_routine' unexpectedly...
Options "-o" and "--output-dir" do not work with other options on Linux ### Expected Behavior The output is produced in the specified directory ### Actual Behavior On Linux: `error: option...
Option "-o" does not work with specified directory when running on Windows ### Expected Behavior The output is produced in the specified directory ### Actual Behavior `error: option -o not...