Skip to content

Commit

Permalink
Add disclaimer about maintenance status
Browse files Browse the repository at this point in the history
  • Loading branch information
NiklasRosenstein authored Feb 2, 2024
1 parent 5e3c7bc commit e47241f
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
![Python versions](https://img.shields.io/pypi/pyversions/pydoc-markdown?style=for-the-badge)
[![Pypi version](https://img.shields.io/pypi/v/pydoc-markdown?style=for-the-badge)](https://pypi.org/project/pydoc-markdown/)

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

Expand Down

0 comments on commit e47241f

Please sign in to comment.