mkdocstrings python issues

mkdocstrings / python

A Python handler for mkdocstrings.

https://mkdocstrings.github.io/python

ISC License

180 stars 33 forks source link

issues

Newest

Newest Most commented Recently updated Oldest Least commented Least recently updated

Fix variables when used in an embedded window like on backstage

#186 ElementalWarrior opened 1 day ago
1
feature: Include all subclasses using a simple API command

#184 DaniBodor opened 4 weeks ago
0
bug: Docstring Style Local Override Does Not Work

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

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

#181 glennmatthews closed 1 month ago
6
feature: bibtex support

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

#155 pawamoy closed 5 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 5 months ago
0
feature: Backlinks

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

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

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

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

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

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

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

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

#145 pedro-psb closed 6 months ago
8
feature: Warn about attributes sections found in `__init__` method docstrings

#144 CunliangGeng opened 6 months ago
3
bug: dependency ceiling markdown>=3.3,<3.6 acts as a timebomb

#143 ssbarnea closed 5 months ago
4
feature: full class source

#142 samvanstroud closed 5 months ago
2
feature: hide toc entry for members

#141 samvanstroud closed 5 months ago
3
bug: Crossref spans for parameter headings are always rendered, they shouldn't

#140 pawamoy closed 6 months ago
1
Unable to get docstring summary, and supress the remainder of the docstring

#139 bschollnick opened 7 months ago
2
feature: warn for type alias without docstring

#138 AntoineD opened 7 months ago
2
bug: Pycon syntax not supported even in Examples section?

#136 MusicalNinjaDad closed 7 months ago
5
feature: Improve rendering of function overloads

#135 pawamoy opened 7 months ago
0
feature: De-duplicate summary sections when sections are written manually and auto-summaries are activated

#134 pawamoy opened 7 months ago
0
feat: Option to generate headings (+ ToC entries) for items in summary tables (attributes, functions/methods, classes, modules)

#133 EvieePy opened 7 months ago
4
bug: Members shadowing a submodule are ignored

#131 NiklasRosenstein closed 6 months ago
2
Add `show_labels` config option

#130 Viicos closed 8 months ago
0
fix: added default value for find_stubs_package

#129 romain-intel closed 8 months ago
0
feat: Add option to search for stubs packages

#128 romain-intel closed 8 months ago
2