GitHub / mkdocstrings/python issues and pull requests
#326 - stale cache in `zensical serve` with mkdocstrings-python
Issue -
State: closed - Opened by tlambert03 21 days ago
- 1 comment
#325 - chore: Update sponsors section in README
Pull Request -
State: closed - Opened by github-actions[bot] about 1 month ago
#323 - ⚠️ mkdocstrings-python is in maintenance mode
Issue -
State: closed - Opened by pawamoy 2 months ago
- 5 comments
#310 - feature: Support hiding details in file __init__.py
Issue -
State: closed - Opened by Xiaokang2022 5 months ago
- 1 comment
Labels: feature
#309 - feature: option to not show enum values
Issue -
State: open - Opened by Ravencentric 5 months ago
Labels: feature
#308 - bug: overloads_only does not work with merge_init_into_class: true
Issue -
State: open - Opened by markuspi 6 months ago
Labels: unconfirmed
#307 - bug: type annotations don't work
Issue -
State: closed - Opened by DetachHead 6 months ago
- 1 comment
Labels: unconfirmed
#306 - feature: include explicit re-exports
Issue -
State: closed - Opened by DetachHead 6 months ago
- 5 comments
Labels: feature
#303 - feature: make `show_docstring_description` further customizable
Issue -
State: open - Opened by ndonkoHenri 7 months ago
Labels: feature
#300 - feat: Add llm_friendly_source option for LLM-compatible source rendering
Pull Request -
State: closed - Opened by S1M0N38 7 months ago
#299 - feature:
Issue -
State: open - Opened by S1M0N38 7 months ago
Labels: feature
#298 - bug: PEP695 `type MyAlias = int` not included in docs while `MyAlias: TypeAlias = int` works fine
Issue -
State: open - Opened by mzebrak 7 months ago
Labels: unconfirmed
#295 - bug: cross-referencing with [x][] fails when using backsticks
Issue -
State: open - Opened by ndonkoHenri 7 months ago
Labels: unconfirmed
#294 - feature: support using backsticks when cross-referencing
Issue -
State: closed - Opened by ndonkoHenri 7 months ago
- 1 comment
Labels: feature
#293 - feat: Hide attribute initial values
Pull Request -
State: closed - Opened by bswck 7 months ago
#292 - An option to hide attribute initial values
Issue -
State: closed - Opened by Maboroshy over 2 years ago
- 2 comments
Labels: feature, insiders
#288 - refactor: Deprecate locale option in favor of mkdocstrings'
Pull Request -
State: closed - Opened by pawamoy 8 months ago
#287 - feat: Customize inheritance chart directions
Pull Request -
State: closed - Opened by bswck 8 months ago
- 1 comment
#286 - feat: Support for hiding implementation signature
Pull Request -
State: closed - Opened by bswck 8 months ago
- 3 comments
#281 - bug: broken `auto_title` in function signatures
Issue -
State: closed - Opened by nataziel 9 months ago
- 1 comment
Labels: bug
#280 - feature: Support parsing of Pydantic BaseModel classes
Issue -
State: open - Opened by TongTong313 9 months ago
Labels: feature
#278 - fix: Use configured heading even when signature is not separated
Pull Request -
State: closed - Opened by pawamoy 9 months ago
#278 - fix: Use configured heading even when signature is not separated
Pull Request -
State: closed - Opened by pawamoy 9 months ago
#276 - bug: class and function names inside h5 are uppercase / missing .code class for names?
Issue -
State: closed - Opened by mzebrak 9 months ago
- 1 comment
Labels: unconfirmed
#275 - bug: New lines removed in an attribute signature
Issue -
State: closed - Opened by webdjoe 10 months ago
- 4 comments
Labels: unconfirmed
#274 - feature: Custom category ordering
Issue -
State: open - Opened by reteps 10 months ago
Labels: feature
#273 - feature: Support footnotes in docstring parameters section
Issue -
State: closed - Opened by dhirschfeld 10 months ago
- 2 comments
Labels: feature
#272 - Update attribute.html.jinja - fix attributes in toc
Pull Request -
State: closed - Opened by davlee1972 10 months ago
- 1 comment
#272 - Update attribute.html.jinja - fix attributes in toc
Pull Request -
State: closed - Opened by davlee1972 10 months ago
- 1 comment
#271 - bug: TOC is displaying full path names for attributes after upgrading from 1.16.8 to 1.16.10
Issue -
State: closed - Opened by davlee1972 10 months ago
- 3 comments
Labels: bug
#270 - feature: Support enabling `signature_crossrefs` without enabling `separate_signature`
Issue -
State: open - Opened by ofek 10 months ago
- 1 comment
Labels: feature, cross-refs, insiders
#269 - Fix inventory `base_url` handling
Pull Request -
State: closed - Opened by connesy 11 months ago
#269 - Fix inventory `base_url` handling
Pull Request -
State: closed - Opened by connesy 11 months ago
#268 - bug: Inventory config 'base_url' no longer works
Issue -
State: closed - Opened by connesy 11 months ago
- 2 comments
Labels: bug
#265 - fix example usage of inventories
Pull Request -
State: closed - Opened by jhominal 11 months ago
#265 - fix example usage of inventories
Pull Request -
State: closed - Opened by jhominal 11 months ago
#264 - bug: Single underscore methods are not filtered out in 0.28.0
Issue -
State: closed - Opened by hugovk 11 months ago
- 1 comment
Labels: bug
#262 - bug: summary of modules in `__init__.py` is not linked to modules
Issue -
State: closed - Opened by patrick-egenlauf 11 months ago
- 3 comments
#261 - bug: doc building suddenly breaks `TypeError`
Issue -
State: closed - Opened by HGangloff 11 months ago
- 1 comment
Labels: unconfirmed
#259 - feature: Setting to have codeblocks un-collapsed as default
Issue -
State: open - Opened by Wesztman 12 months ago
Labels: feature
#258 - bug: Symlinks are not followed to find `.pyi` files
Issue -
State: closed - Opened by kylebarron 12 months ago
- 1 comment
Labels: bug
#254 - change: Generate mermaid diagrams at build time?
Issue -
State: open - Opened by pawamoy 12 months ago
#253 - feature: Option to link source
Issue -
State: open - Opened by reteps 12 months ago
- 6 comments
Labels: feature, insiders
#252 - refactor: Prepare backlinks support
Pull Request -
State: closed - Opened by pawamoy 12 months ago
#252 - refactor: Add backlinks metadata to autorefs elements
Pull Request -
State: open - Opened by pawamoy 12 months ago
#251 - bug: GoogleStyleOptions.__init__() got an unexpected keyword argument 'merge_init_into_class'
Issue -
State: closed - Opened by jzazo 12 months ago
- 2 comments
#250 - feature: show_overloads
Pull Request -
State: closed - Opened by reteps 12 months ago
- 5 comments
#246 - docs: regression, no `python` property in schema
Issue -
State: closed - Opened by mattmess1221 about 1 year ago
- 2 comments
Labels: bug, docs
#245 - bug: Attributes not inherited when using `inherited_members = True`
Issue -
State: closed - Opened by toby-coleman about 1 year ago
- 1 comment
Labels: unconfirmed
#244 - feat: Improve the languages zh and ja of templates
Pull Request -
State: closed - Opened by Xiaokang2022 about 1 year ago
- 1 comment
#244 - feat: Improve the languages zh and ja of templates
Pull Request -
State: closed - Opened by Xiaokang2022 about 1 year ago
- 1 comment
#243 - feature: Add a new symbol `Package`
Issue -
State: closed - Opened by Xiaokang2022 about 1 year ago
- 1 comment
Labels: feature
#242 - feat: remove annotations for properties in attributes section
Pull Request -
State: open - Opened by elfkuzco about 1 year ago
#242 - feat: remove annotations for properties in attributes section of summary
Pull Request -
State: closed - Opened by elfkuzco about 1 year ago
#240 - bug: Cannot import `mkdocstrings-python>=1.14.0` if Pydantic v1 is installed
Issue -
State: open - Opened by jvstme about 1 year ago
Labels: unconfirmed
#239 - docs: Update instructions for "options" section of mkdocs.yml
Issue -
State: closed - Opened by melissawm about 1 year ago
- 4 comments
Labels: docs
#238 - feature: include proper labels when inspecting compiled module
Issue -
State: closed - Opened by elfkuzco about 1 year ago
- 1 comment
Labels: feature
#237 - bug: cyclic aliases detected when inspecting compiled modules
Issue -
State: closed - Opened by elfkuzco about 1 year ago
- 1 comment
Labels: unconfirmed
#236 - Add heading and toc_label settings
Pull Request -
State: closed - Opened by vancromy about 1 year ago
- 2 comments
#236 - Add heading and toc_label settings
Pull Request -
State: closed - Opened by vancromy about 1 year ago
- 2 comments
#235 - feature: show only the 'summary' of attributes and include defaults
Issue -
State: open - Opened by osamimi about 1 year ago
Labels: feature
#234 - feature: support for __init__() of pedantic/attrs classes
Issue -
State: closed - Opened by osamimi about 1 year ago
- 1 comment
Labels: feature
#233 - bug: inherited_members does not get docstring for @abstractmethod
Issue -
State: open - Opened by osamimi about 1 year ago
Labels: unconfirmed
#232 - bug: Deprecation Warning
Issue -
State: closed - Opened by MaKaNu about 1 year ago
- 1 comment
Labels: unconfirmed
#231 - feat: allow `force_inspection` option to be configurable
Pull Request -
State: closed - Opened by elfkuzco about 1 year ago
- 7 comments
#231 - feat: allow `force_inspection` option to be configurable
Pull Request -
State: closed - Opened by elfkuzco about 1 year ago
- 7 comments
#230 - feature: Support for accessors
Issue -
State: open - Opened by znichollscr about 1 year ago
Labels: feature
#229 - feature: Support for accessors
Issue -
State: closed - Opened by znicholls about 1 year ago
- 1 comment
Labels: feature
#227 - bug: mkdocstrings-python does not render Google-style Deprecated sections (missing template?)
Issue -
State: closed - Opened by the-13th-letter about 1 year ago
- 10 comments
Labels: bug, extractor: griffe, templates
#226 - feat: Show member summary but not the members themselves
Issue -
State: closed - Opened by pawamoy about 1 year ago
- 1 comment
Labels: feature, insiders
#225 - refactor: Use dataclasses for configuration/options and automate schema generation
Pull Request -
State: closed - Opened by pawamoy about 1 year ago
#225 - refactor: Use dataclasses for configuration/options and automate schema generation
Pull Request -
State: closed - Opened by pawamoy about 1 year ago
#223 - bug: properties vs attributes in classes
Issue -
State: closed - Opened by mbraakhekke about 1 year ago
- 1 comment
Labels: unconfirmed
#222 - feature: Ignore metadata added to dataclass attributes via typing.Annotated (or typing_extensions.Annotated)
Issue -
State: closed - Opened by nfelt14 about 1 year ago
- 2 comments
Labels: feature
#221 - Support PEP 695 generics
Pull Request -
State: open - Opened by viccie30 about 1 year ago
#221 - Support PEP 695 generics
Pull Request -
State: closed - Opened by viccie30 about 1 year ago
- 1 comment
#219 - feature: `members_order = '__all__'`
Issue -
State: closed - Opened by samuelcolvin about 1 year ago
- 3 comments
Labels: feature, insiders
#218 - feature: Hide attributes, but render in summary
Issue -
State: closed - Opened by reteps about 1 year ago
- 3 comments
Labels: feature
#217 - change: Render first HTML paragraph instead of first docstring line for summaries
Issue -
State: open - Opened by pawamoy about 1 year ago
#216 - Allow ruff to be used as a formatter
Pull Request -
State: closed - Opened by DarkaMaul about 1 year ago
- 9 comments
#216 - Allow ruff to be used as a formatter
Pull Request -
State: closed - Opened by DarkaMaul about 1 year ago
- 7 comments
#215 - bug: Class init parameter name disappears from attribute docstring using `separate_signature`
Issue -
State: open - Opened by connesy about 1 year ago
Labels: unconfirmed
#214 - feature: Inform users when local option has no effect
Issue -
State: open - Opened by pawamoy about 1 year ago
Labels: feature
#213 - feature: Option to hide implementation signature in case of overloads
Issue -
State: open - Opened by pawamoy about 1 year ago
Labels: feature, insiders, fund
#212 - bug: merge_init_into_class does not merge overloads
Issue -
State: closed - Opened by kaktus42 about 1 year ago
- 2 comments
Labels: bug, templates
#211 - fix: Fix normalization of extension paths on the annoying operating system and Python 3.13
Pull Request -
State: closed - Opened by pawamoy about 1 year ago
#211 - fix: Fix normalization of extension paths on the annoying operating system and Python 3.13
Pull Request -
State: closed - Opened by pawamoy about 1 year ago
#210 - fix: Don't merge parent `__init__` docstring into class docstring if such inherited method wasn't selected through the `inherited_members` configuration option
Pull Request -
State: open - Opened by pawamoy about 1 year ago
#210 - fix: Don't merge parent `__init__` docstring into class docstring if such inherited method wasn't selected through the `inherited_members` configuration option
Pull Request -
State: closed - Opened by pawamoy about 1 year ago
#209 - change: Remove stale branches
Issue -
State: open - Opened by bswck about 1 year ago
#207 - feature: Convert `Unpack[TypedDict]` to regular arguments
Issue -
State: closed - Opened by llucax about 1 year ago
- 13 comments
Labels: feature
#206 - feature: Customizable inheritance diagram chart direction
Issue -
State: open - Opened by nfelt14 about 1 year ago
Labels: feature
#205 - bug: Custom summary page template broken when using insiders
Issue -
State: closed - Opened by nfelt14 about 1 year ago
- 5 comments
#203 - bug:
Issue -
State: open - Opened by ringohoffman over 1 year ago
Labels: unconfirmed
#202 - bug: broken crossref links when the field name matches type name
Issue -
State: open - Opened by cmclaughlin over 1 year ago
Labels: unconfirmed
#200 - change: unique source code span and codeline IDs
Issue -
State: open - Opened by brynpickering over 1 year ago
#199 - docs: Documentation updates
Issue -
State: open - Opened by pawamoy over 1 year ago
Labels: docs
#198 - feature: Manually specify external docs url for docs without objects.inv
Issue -
State: open - Opened by ItsDrike over 1 year ago
Labels: feature
#197 - bug: `show_docstring_attributes: false` is non-functional
Issue -
State: closed - Opened by Archmonger over 1 year ago
- 2 comments
Labels: unconfirmed
#196 - bug: Classes that inherit from a parent class in another module do not inherit the docstrings unless they implement an init method
Issue -
State: closed - Opened by nfelt14 over 1 year ago
- 30 comments
Labels: unconfirmed