issues
search
mkdocstrings
/
python
A Python handler for mkdocstrings.
https://mkdocstrings.github.io/python
ISC License
190
stars
35
forks
source link
docs: Documentation updates
#199
Open
pawamoy
opened
3 weeks ago
pawamoy
commented
3 weeks ago
Meta issue for tracking documentation improvements.
[ ] limitation with footnotes, references (see
https://github.com/mkdocstrings/pytkdocs/issues/26
)
[ ] how to document enumeration values
[ ] recommendation: giving a heading to each object, even modules
[ ] suggest
https://github.com/analog-garage/mkdocstrings-python-xref
as alternate handler with relative cross-refs
[ ] suggest
https://github.com/jcayers20/mkdocs-autoapi
for automatic generation of pages (see
https://github.com/mkdocstrings/mkdocstrings/issues/389
)
[ ]
see all issues with docs label
Meta issue for tracking documentation improvements.