python
python copied to clipboard
mkdocstrings
A Python handler for mkdocstrings.
### Is your feature request related to a problem? Please describe. Currently if a class inherits from a class of another package, this other class is not resolved and therefore...
### Is your feature request related to a problem? Please describe. I'm having fun looking at [matrix-nio's API](https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.responses.JoinedRoomsResponse), and also having trouble finding how to get the details of a...
The fallback mechanism is sometimes confusing when overriding templates and using a theme different than the fallback one. For example if one uses the `nature` theme, they have to use...
With our growing number of rendering options, it is hard to make sure that changes to templates do not cause regressions. We should add end-to-end tests for all combinations of...
### Description of the bug If attributes are documented in the `__init__` method (see class below), their types are missing after rendering (see the screenshot). ``` class MolecularFamily: def __init__(self,...
### Is your feature request related to a problem? Please describe. Where used, type aliases without docstring are rendered with no link to their definition. ### Describe the solution you'd...
**Is your feature request related to a problem? Please describe.** For modules with mathematical correlations/equations, the code can sometimes be much shorter than the docstring - especially when LaTeX equations...
### Description of the bug From my reading of the documentation, I don't see any way to supress the docstring, and only show the summary line(s) of the docstring. We...
### Is your feature request related to a problem? Please describe. Originally discussed here: https://github.com/mmacy/openai-python/issues/7 It can be useful to have docstrings in overloads as well as in the implementation....