mkdocstrings mkdocstrings issues

mkdocstrings / mkdocstrings

:blue_book: Automatic documentation from sources, for MkDocs.

https://mkdocstrings.github.io/

ISC License

1.62k stars 102 forks source link

issues

Newest

Newest Most commented Recently updated Oldest Least commented Least recently updated

feature: Options to control some aspects of Markdown rendering of docstrings

#675 pawamoy opened 1 week ago
0
feature: allow omitting return types for numpy stringdocs

#674 carlocastoldi closed 1 week ago
3
feature: No-TOC YAML option

#672 pawamoy opened 1 month ago
0
feature: No-inventory YAML option

#671 pawamoy opened 1 month ago
0
Can't get Mkdocstrings to understand Numpy docstrings

#670 ldouteau closed 2 weeks ago
2
bug: rendering overloaded methods generates spurious warnings

#669 aaron-siegel opened 1 month ago
4
Feature Request: Toggle Python Interactive Prompts in Code Blocks

#668 nh916 opened 1 month ago
5
feat: Allow hooking into autorefs when converting Markdown docstrings

#666 pawamoy opened 1 month ago
0
Handler for C code

#665 ZeroIntensity closed 2 months ago
1
Feature Request: Configurable Admonitions Mapping in `mkdocs.yaml` for `mkdocstrings`

#664 nh916 opened 2 months ago
1
bug: show_symbol_type_toc stopped working with markdown==3.6.0

#662 daroczig closed 3 months ago
5
feature: Jinja handler

#661 pawamoy opened 3 months ago
6
bug: Doctest formatting

#659 andreisorokin-astrazeneca closed 3 months ago
1
feature: Fine-grain configuration

#658 pawamoy opened 3 months ago
0
feature: Link to code on GitHub

#657 andgineer opened 3 months ago
0
feature: Hide imported symbols (objects, modules etc)

#656 andreisorokin-astrazeneca opened 3 months ago
5
bug: When `show_symbol_type_toc: true`, module or class followed by another group do not render properly

#655 ActurialCapital closed 3 months ago
4
problem finding own module

#653 luhborba closed 4 months ago
3
Pycon code blocks not rendered as such even within Examples section

#652 MusicalNinjaDad closed 4 months ago
1
refactor: Backup anchors without hrefs, for compatibility with autorefs' Markdown anchors

#651 pawamoy closed 4 months ago
3
Symbol headings with a custom theme

#650 ZeroIntensity closed 2 months ago
5
Circumvent error with mkdocs link.

#649 MrCurtis closed 5 months ago
0
bug: ModuleNotFoundError: No module named 'mkdocstrings_handlers'

#648 cldtech closed 5 months ago
3
bug: No module named 'mkdocstrings_handlers'

#647 SamTov closed 5 months ago
4
bug: griffe 0.39.0 - cannot collect data encapsulated in two folders with the same name

#646 IronTopi closed 5 months ago
3
feat: i18n support

#645 BlueGlassBlock opened 5 months ago
0
How to get the "mod", "class", "attr"... notations?

#643 NahuelCostaCortez closed 5 months ago
1
feature: Link to function parameters

#640 Kludex closed 5 months ago
14
be consistent in examples

#639 nerdoc closed 6 months ago
0
How to add the label for "attribute" vs "method" in the reference documentation?

#638 AlessandroMondin00 closed 6 months ago
1
TypeScript handler

#636 pawamoy opened 7 months ago
12
bug: `templates` of `custom_templates` setting now needs to be an existing directory

#634 Marenz closed 7 months ago
4
feat: Cache downloaded inventories as local files

#632 oprypin closed 7 months ago
0
Fix tests, fix/ignore typing

#631 pawamoy closed 7 months ago
4
fix: `custom_templates` config was dropped in previous commit

#630 oprypin closed 8 months ago
3
Drop support for MkDocs < 1.4, modernize usages

#629 oprypin closed 8 months ago
0
docs: Make recipe work with MkDocs `-f` option

#628 pawamoy closed 7 months ago
0
Make custom_templates relative to config file

#627 waylan closed 8 months ago
4
feat: Update relative links in docstrings of objects from other packages

#626 pawamoy opened 8 months ago
0
docs: Use `__file__` instead of current working directory in autopages recipe

#625 pawamoy closed 7 months ago
1
Error: ModuleNotFoundError: No module named 'mkdocstrings_handlers

#623 rodrwankenobi closed 9 months ago
1
Include external file contents from inside docstring?

#620 mdaeron closed 9 months ago
0
How to clean up the source code path when using `gen_ref_pages.py`?

#619 Andrew-S-Rosen closed 9 months ago
0
How to display all members of an Object, without showing the object itself ?

#616 astariul closed 7 months ago
2
Compatibility with `mkdocs-macros`

#615 llucax opened 9 months ago
21
Hot Reload Not Working in `mkdocstrings[python]==0.23.0`

#614 nh916 closed 9 months ago
1
fix: Properly fix duplicated headings for nested docstrings

#613 oprypin closed 9 months ago
0
Source code link to repository

#612 Anselmoo closed 9 months ago
8
Change naming from `mkdocstrings` to `mkdocs-strings`

#611 Anselmoo closed 9 months ago
1
Remove duplicated headings for docstrings nested in tabs/admonitions

#610 percevalw closed 9 months ago
1