为 dendrophiles 提供简约的 Python 文档。

treedoc 以树状结构打印简约的 Python 文档，旨在在单个对象的详细信息与对象属性表面信息之间找到最佳平衡。

treedoc 非常适合

• 在不滚动浏览整个网站的情况下，快速了解一个包的概览。
• 在文档中搜索。
• 打印不同 Python 对象的必要信息。

安装

从 Python 包索引 (PyPI) 使用 pip install treedoc 进行安装。

用法

treedoc 可以通过命令行界面直接使用，也可以在 Python Shell 或 Jupyter Notebook 中交互式使用。有关参数的更多信息，请参阅 treedoc --help 或 help(treedoc)。

命令行界面

Python Shell 和笔记本

treedoc 可以像其他任何包一样导入和使用，例如在交互式 Python 解释器会话或 Jupyter Notebook 中。

解释器

Jupyter Notebook

贡献

欢迎贡献。如果您想解决某个问题，请创建一个拉取请求以获取反馈。我们的目标是

• 无依赖，但测试依赖是允许的。
• 符合习惯、干净的Python代码。可读性很重要。
• 彻底的测试和代码格式化，请参阅.travis.yml了解由持续集成运行的命令。