wechaty / python-wechaty

Python Wechaty is a Conversational RPA SDK for Chatbot Makers written in Python
https://wechaty.readthedocs.io/zh_CN/latest/
Apache License 2.0
1.56k stars 229 forks source link

Automatic documentation from sources #313

Open wj-Mcat opened 2 years ago

wj-Mcat commented 2 years ago

Introduction

The best of the document is the source code, and we should use the docstring, which contains description and example codes, of module/functions as the document.

For the part of the document , eg API reference, can be generated with tools. If it has been done, the document will give more details to developers. So this featrue is vital for python-wechaty.

Tools