Skip to content

Commit e47241f

Browse files
Add disclaimer about maintenance status
1 parent 5e3c7bc commit e47241f

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
![Python versions](https://img.shields.io/pypi/pyversions/pydoc-markdown?style=for-the-badge)
44
[![Pypi version](https://img.shields.io/pypi/v/pydoc-markdown?style=for-the-badge)](https://pypi.org/project/pydoc-markdown/)
55

6+
> __Disclaimer__: I don't find enough time to properly maintain and develop this project. If you want to generate
7+
> docstrings for your Python project with MkDocs, consider [mkdocstrings](https://mkdocstrings.github.io/) instead.
8+
69
Pydoc-Markdown is a tool to create Python API documentation in Markdown format. Instead of executing your Python
710
code like so many other documentation tools, it parses it using [docspec][] instead.
811

0 commit comments

Comments
 (0)