mkdocstrings python issues

mkdocstrings / python

A Python handler for mkdocstrings.

https://mkdocstrings.github.io/python

ISC License

190 stars 35 forks source link

issues

Newest

Newest Most commented Recently updated Oldest Least commented Least recently updated

bug: Custom summary page template broken when using insiders

#205 nfelt14 closed 1 day ago
5
bug: Non-exported submodules included in Modules table following "Auto-summary of members"

#203 ringohoffman opened 1 week ago
1
bug: broken crossref links when the field name matches type name

#202 cmclaughlin closed 2 weeks ago
3
change: unique source code span and codeline IDs

#200 brynpickering opened 3 weeks ago
2
docs: Documentation updates

#199 pawamoy opened 3 weeks ago
0
feature: Manually specify external docs url for docs without objects.inv

#198 ItsDrike opened 4 weeks ago
3
bug: `show_docstring_attributes: false` is non-functional

#197 Archmonger closed 1 month ago
2
bug: Classes that inherit from a parent class in another module do not inherit the docstrings unless they implement an init method

#196 nfelt14 closed 4 weeks ago
30
Add option `docstring_inherit_strategy`

#195 thomasmarwitz closed 1 month ago
4
feature: Add option s.t. overridden members are able to "inherit" docstrings from corresponding members in parent classes

#194 thomasmarwitz closed 1 month ago
1
change: Make signatures formatting more consistent?

#193 pawamoy opened 1 month ago
3
bug: Enabling pymdownx line numbers globally also renders them in signatures

#192 pawamoy opened 1 month ago
0
bug: signature with string not properly rendered as of version 1.12.0

#191 gautierronan closed 1 month ago
3
bug: Parent class' `__init__` docstring merged into class docstring even if inherited members are not picked up

#189 pawamoy opened 1 month ago
0
docs: Recommend to set default language to python for code blocks?

#187 pawamoy opened 1 month ago
0
Fix variables when used in an embedded window like on backstage

#186 ElementalWarrior closed 1 month ago
4
feature: Include all subclasses using a simple API command

#184 DaniBodor opened 2 months ago
0
bug: Docstring Style Local Override Does Not Work

#183 triley13 opened 2 months ago
3
bug: Typing.Overload from pyi file not showing in generated docs

#182 nvoxland-al opened 3 months ago
13
bug: Incompatible with griffe v1.0

#181 glennmatthews closed 3 months ago
6
feature: bibtex support

#180 shenxiangzhuang closed 3 months ago
1
feature: example code block copy without prompt

#179 shenxiangzhuang closed 3 months ago
1
feature: prevent overflow for long object names/headings

#177 joaopalmeiro opened 3 months ago
2
fallback_theme option is not overridable

#176 carlocastoldi closed 2 months ago
9
bug: mkdocstrings not collecting type information from parent classes

#175 coltonbh opened 3 months ago
14
Fix link to griffe.Parsers in docstrings options summary

#174 melissawm closed 3 months ago
1
Deprecation warnings with Griffe 0.48

#173 pawamoy closed 3 months ago
0
feature: highlight functions decorated with `@deprecated`

#171 eddiebergman opened 4 months ago
1
feature: Add option to filter out imported objects (true by default for backward compatibility)

#170 pawamoy opened 5 months ago
0
bug: AliasResolutionError: Could not resolve alias errors when doing simple re-exports

#168 Ark-kun closed 5 months ago
4
bug: [Python] Most classes in the module show no members. Really weird bug

#165 Ark-kun closed 5 months ago
3
feature: Allow filtering objects in templates thanks to labels

#164 pawamoy opened 6 months ago
0
bug: TypeError: '<' not supported between instances of 'NoneType' and 'int' when rendering source

#163 pawamoy closed 6 months ago
0
feature: Filter shown base classes

#161 lars-reimann opened 6 months ago
1
Correct `PrintOK` doctest examples

#159 bswck closed 6 months ago
3
bug: `show_symbol_type_toc` not working with newest version of Python handler / material theme

#158 femtomc closed 6 months ago
17
feature: extension(?): relative cross-references in docstrings, but resolved by the handler/extractor

#166 the-13th-letter closed 2 months ago
8
tests: Add end-to-end tests, many options combinations, using inline-snapshot

#157 pawamoy opened 6 months ago
0
docs: Document Jinja templates

#156 pawamoy closed 6 months ago
1
refactor: Deprecate `*.html` templates in favor of `*.html.jinja` ones

#155 pawamoy closed 6 months ago
0
feature: Show all classes in inheritance diagrams, not just the ones that can be resolved in the current project

#154 pawamoy opened 6 months ago
0
feature: Backlinks

#153 pawamoy opened 6 months ago
0
refactor: Stop relying on the template fallback mechanism?

#152 pawamoy opened 7 months ago
0
task: Rename templates to template.html.jinja

#151 pawamoy closed 6 months ago
0
tests: Write end-to-end tests

#150 pawamoy opened 7 months ago
1
task: Comment templates

#149 pawamoy closed 6 months ago
0
fix: respect `show_root_full_path` for ToC entries

#148 jbott closed 5 months ago
4
docs: Make it more prominent that show_submodules is needed for recursivley documenting submodules

#146 pawamoy opened 7 months ago
0
feature: link to re-export instead of inserting full documentation

#167 JP-Ellis opened 7 months ago
5
feature: Add `try_relative_path` option (for Griffes)

#145 pedro-psb closed 7 months ago
8