__doc__ for RustPython

这是RustPython中用Rust编写的对象的__doc__属性生成器。

它由两部分组成

• 脚本generate_docs.py，用于从CPython提取__doc__属性到docs.inc.rs
• rust craterustpython-doc，它使用docs.inc.rs文件创建文档数据库。

然后，此文档数据库被rustpython-derive crate的宏pymodule和pyclass宏用于自动添加__doc__属性。

docs.inc.rs数据库文件可以用以下方式生成

$ python -m venv gendocs
$ source gendocs/bin/activate
$ python -I generate_docs.py <path_to_RustPython> docs.inc.rs
$ deactivate

或使用docker

$ docker pull python:slim
$ docker run python:slim python --version
Python 3.10.8
$ ls
__doc__  RustPython
$ docker run -v $(pwd):/RustPython -w /RustPython/__doc__ python:slim python generate_docs.py ../RustPython docs.inc.rs

在测试前不要忘记更新cargo

$ cargo update

为什么__doc__没有变化？

检查旧的文档中实现的注释是否仍然存在

RustPython优先考虑用户定义的文档。请检查源代码中是否还存在旧的注释。如果存在，简单删除它们就可以解决问题。

贡献

我们非常欢迎贡献，在许多情况下，我们很乐意通过PR或gitter指导贡献者。请参阅开发指南以获取有关发展的提示。

许可

本项目的许可协议为MIT许可。有关更多详细信息，请参阅LICENSE文件。

项目标志（点击查看）的许可协议为CC-BY-4.0许可。有关更多详细信息，请参阅LICENSE-logo文件。