From e47241f0efd295bc3f6e532e0e136a6fe53c0256 Mon Sep 17 00:00:00 2001 From: Niklas Rosenstein Date: Fri, 2 Feb 2024 14:38:19 +0100 Subject: [PATCH] Add disclaimer about maintenance status --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 9c10bb53..792367f1 100644 --- a/README.md +++ b/README.md @@ -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.