pytkdocs
pytkdocs copied to clipboard
mkdocstrings
Load Python objects documentation.
I have code that subclasses a class in the bokeh library ```python from bokeh.application.handlers import Handler from bokeh.server.server import Server class ShutdownOnSessionDestroyed(Handler): """A bokeh application handler that will shutdown server...
I have seen errors like `Failed to get 'name: description' pair from ''`, which even given the name of the docstring, can be hard to track down. It would be...
**Describe the bug** If a data class is created using the function `dataclasses.make_dataclass` instead of the `@dataclasses.dataclass` decorator, then the docstring (and even the entire node attribute data) is empty....
**Is your feature request related to a problem? Please describe.** Yes, the problem is that some libraries use different attributes for docstrings than just `__doc__`. For example, when using [`plumbum.cli.SwitchAttr`](https://plumbum.readthedocs.io/en/latest/cli.html#switch-attributes),...
**Is your feature request related to a problem? Please describe.** I'm documenting a package but I only care about classes of certain types. Specifically, those that inherit (directly, or indirectly)...
**Describe the bug** I've set inherited_memberse to true in my selector to pull in members that are inherited from classes that I've built. Essentially, I have a class Mergeable, that...
**Describe the bug** It seems `pytkdocs` has trouble detecting a class attribute's type when the class is decorated. **To Reproduce** See an example here: https://github.com/copier-org/copier/pull/203#discussion_r459869048. The description is correctly parsed...
**Is your feature request related to a problem? Please describe.** Sometimes it's a bit redundant to add a type annotation. See for example https://github.com/copier-org/copier/pull/203#discussion_r459873226 **Describe the solution you'd like** Instead...
**Describe the bug** When collecting type-alias attributes, pytkdocs in some cases incorrectly collects a path under the `typing` module. This seems to happen when the type alias is an alias...
**Describe the bug** Individual attribute docstrings are re-applied to inherited class attributes even when not selecting inherited members. It doesn't feel right when autodocumenting a class and its subclasses in...