pytkdocs

pytkdocs copied to clipboard

Decorator to ignore specific functions during the docstrings "discovery"

4

**Is your feature request related to a problem? Please describe.** My prod is currently in Django 3.2, but I have some unused modules already containing code that will be ready...

Skrattoune

pytkdocs/django compatibility issues

5

**Please open an issue on [pytkdocs](https://github.com/pawamoy/pytkdocs/issues) instead if this is related to Python docstrings parsing or the collection of Python objects!** **Describe the bug** Having pytkdocs >= 0.12.0 causes mkdocstrings...

jmcgill298

[BUG] pandera model wrongly detected as pydantic and pytkdocs tries to read non existent attributes

7

First of all, thanks for developing pytkdocs! I do not use pytkdocs directly, but rather mkdocs and mkdocstrings which call pytkdocs. Here is an example for reproduction. ```python import pandera...

camold

Enable the inheritance of classmethod for docstrings

4

Currently the docstrings for inherited classmethods are completely ignored, this forces the user make trivial reimplementation of methods such as `__init__` just to show proper documentation. Original disscutions: https://github.com/pawamoy/mkdocstrings/issues/78#issuecomment-664537828

cgarciae

Decorators which alternate docstrings are ignored

3

Hi, I've currently switched to mkdocs and I have have to say that this is an amazing project :) But there are a few minor issues I did not manage...

braniii

[BUG] Pydantic model fields don't display in documentation

4

**Describe the bug** I just saw the issue #9, and it looks like Pydantic models are supported, however I couldn't manage adding a Pydantic model in documentation. I use `pytkdocs`...

ysfchn

Return members in the same given order

6

**Is your feature request related to a problem? Please describe.** Feature asked in mkdocstrings: https://github.com/pawamoy/mkdocstrings/issues/102#issuecomment-622204877 **Describe the solution you'd like** - pytkdocs should re-order the root object children using the...

pawamoy

[BUG] Error displaying wrapped Python functions where wrapper is from another module

3

**Describe the bug** I am using a function wrapper to produce multiple functions from a stub one, and set the produced function with different names and docs. However, the produced...

roastduck

[BUG] detect_field_model fails for DjangoModelFactory from factory-boy

3

**Describe the bug** I use `mkdocstrings` and have a Django project where I started using `factory-boy`. Once I added a factory class (sub-class of `factory.django.DjangoModelFactory`) the following error occurs: ```python...

mschoettle

[BUG] Wrong docstrings for attribute when aliased from another class

2

**Describe the bug** As you can see here: https://github.com/aminalaee/sqladmin/blob/main/sqladmin/models.py#L358 We have defined a member to be equal to an external third-party class: ```python class X: form_base_class = wtforms.Form """Some docstrings"""...

aminalaee