跳到主要内容

pyDocusaurus

面向 Python 模块包开发者的现代文档站点生成器,如同 Sphinx 那样基于文档字符串 (docstring)。

Start with Python Docstrings

从 Python Docstring 出发

pyDocusaurus 可以应用于一个已经包含了完整文档字符串 (docstring) 的现存模块包。开发者只需要聚焦于编写自己的 Python docstring,而本项目将谱写余下的部分。现在就可以开始上手,将你的 docstring 转化为 Docusaurus 文档。

Powered by pyDocusaurus

由 pyDocusaurus 驱动

pyDocusaurus 将分析源码中的 docstring 结构、以及 类型提示。这些信息将汇聚、统合为复杂的文档页面。

Easy to Use

驾轻就熟

与老派的 Sphinx 不同,本项目生成的 Docusaurus 文档构筑于现代且先进的 React 之上。pyDocusaurus 提供了“现代类型提示系统”与“即时加载网站”之间的桥梁。