mkdocstrings / pytkdocs

Load Python objects documentation.

https://mkdocstrings.github.io/pytkdocs

mkdocstrings/pytkdocs Issues

Decorator to ignore specific functions during the docstrings "discovery"
Updated a year ago4
pytkdocs/django compatibility issues
Updated a year ago5
[BUG] pandera model wrongly detected as pydantic and pytkdocs tries to read non existent attributes
Updated a year ago7
Decorators which alternate docstrings are ignored
Updated a year ago3
`inherited_members` Does **Not** Work
Closed 2 years ago4
[BUG] Pydantic model fields don't display in documentation
Updated 2 years ago4
[BUG] 'builtin_function_or_method' object is not subscriptable
Closed 2 years ago2
[BUG] Error displaying wrapped Python functions where wrapper is from another module
Updated 2 years ago3
[BUG] detect_field_model fails for DjangoModelFactory from factory-boy
Updated 2 years ago3
[BUG] use of `set` as class attribute type causes exception
Closed 2 years ago5
[BUG] Wrong docstrings for attribute when aliased from another class
Updated 2 years ago2
[BUG] type unions with pipes not supported
Updated 2 years ago2
[BUG] missing numpydoc parameters validation resulting in Nonetype exception
Closed 2 years ago2
[DOCS] Docstrings don't match up with function parameters
Closed 3 years ago1
[BUG] Pytkdocs Loader assumes '_meta' attribute of classes has a 'get_fields' method
Closed 3 years ago5
Nasty direct path to own types.
Closed 3 years ago2
[BUG] No error information from parsing python source
Closed 3 years ago5
Incorrect function's argument representation with 2 underscores
Closed 3 years ago5
[BUG] individually annotated attributes in __init__ not discovered
Closed 3 years ago2
Attribute annotation (and its docstring) doesn't show up unless it has a value
Closed 3 years ago5
Expose type alias instead of actual type
Closed 3 years ago3
Allow using "import" path of an object rather than the "real path" (where it was defined)
Closed 3 years ago1
[BUG] Dataclass Initialisation argument types and defaults not detected
Closed 3 years ago2
Line numbers in error messages
Updated 3 years ago1
Add support for help_text field parameter as description with django model fields.
Closed 3 years ago
[BUG] Support typing-extensions 4.x
Closed 3 years ago2
[BUG] Cannot extract docstring from output of `make_dataclass`
Updated 3 years ago
[BUG] Wrong version from python package
Closed 3 years ago2
Fails on __init__() method with valid but peculiar indentation
Closed 3 years ago7
Support 'Yields' in Google-style docstrings
Closed 3 years ago4
Remove new_path_syntax option
Closed 3 years ago1
Switch new_path_syntax default value to True
Closed 3 years ago1
Refactor
Closed 3 years ago5
Plugin/hook system
Closed 3 years ago1
[BUG] collections.namedtuple leads to source not found warning
Closed 3 years ago1
Filter based on class inheritance
Updated 3 years ago1
[BUG?] wxPython breaks mkdocstrings
Closed 3 years ago4
Implement terminal colors for Windows
Closed 3 years ago1
[BUG] Enum's __class__ etc. are pulled in when inherited_members is true
Updated 3 years ago3
Support "Keyword Arguments" sections in Google-style docstrings
Closed 3 years ago3
[BUG] pytkdocs must be installed with 'numpy-style'
Closed 3 years ago4
[BUG] AttributeError: 'Name' object has no attribute 'value' (again)
Closed 3 years ago3
[BUG] Upgrading to 0.11.0 fails -- Can't find README
Closed 3 years ago2
[BUG] Pydantic Field documentation generates wrong type for List/Set/Tuple
Closed 3 years ago1
Doesn't report a cached_property
Closed 4 years ago5
[BUG] Properties do not inherit superclass docstrings
Closed 4 years ago2
[BUG] Dict[] type annotations make pytkdocs explode
Closed 4 years ago5
AttributeError Name object has no attribute value
Closed 4 years ago3
Add reStructured parser
Closed 4 years ago5
Accept dotted-paths of the form path.to.module:object1.object2
Closed 4 years ago1