最简单的python文档。
treedoc的Python项目详细描述
最简单的python文档。
treedoc以树结构打印最简的python文档, 目的是在有关 单一对象和有关对象属性的表面信息。
treedoc非常适合:
- 不必无休止地在网站上滚动查看软件包。
- 搜索文档。
- 打印关于不同python对象的基本信息。
安装
使用pip install treedoc
从Python Package Index(pypi)安装。
用法
treedoc可以直接通过命令行界面使用,
或者在python shell或jupyter笔记本中交互。了解更多信息
关于参数,请参见treedoc --help
或help(treedoc)
。
命令行界面
Python外壳和笔记本
treedoc可以像任何其他包一样导入和使用,例如 交互式python解释器会话或jupyter笔记本。
口译员
Jupyter笔记本
贡献
欢迎捐款。 如果你想解决一个问题,请创建一个pull request来获取反馈。 我们的目标是:
- 零依赖项,但测试依赖项是可以的。
- 惯用的、干净的python代码。可读性很重要。
- 彻底的测试和代码格式化,请参阅
.travis.yml
以获取通过持续集成运行的命令。