如何通过pydoc离线访问numpy、scipy等第三方库的文档?
用pydoc本地访问第三方库文档的方法
其实pydoc本身支持访问第三方库的文档,只要库安装正确且带有规范的文档字符串(docstring),不需要额外生成特殊文档,以下是具体操作:
直接用pydoc命令查询
只要第三方库是通过pip(或其他包管理工具)安装在当前Python环境的site-packages目录下,pydoc会自动识别并加载它的文档。直接执行类似命令即可:pydoc numpy pydoc numpy.pi pydoc numpy.linspace如果遇到找不到库的情况,大概率是环境问题:比如你激活了虚拟环境但没在对应终端执行命令,或者pip安装的库和当前调用的
python/pydoc不属于同一个环境。可以用which python和which pip检查路径是否一致,或者直接用对应环境的解释器调用pydoc:python -m pydoc numpy.linspace生成本地HTML文档(可选)
如果想把第三方库的文档生成本地HTML文件离线浏览,执行:pydoc -w numpy命令会在当前目录生成
numpy.html文件,直接用浏览器打开就能查看完整文档。启动pydoc本地服务器(更便捷的浏览方式)
执行以下命令启动一个本地文档服务器:pydoc -p 8000然后在浏览器访问
localhost:8000,就能看到当前Python环境下所有可访问的库(包括标准库和第三方库)的文档索引,点击对应库就能在线浏览,体验和官方文档类似但完全本地。
注意:如果某些第三方库的文档字符串写得不够完善,pydoc显示的内容可能会简略,这取决于库本身的文档编写质量,和pydoc工具无关。
内容的提问来源于stack exchange,提问作者ksinkar
相关产品推荐
相关产品推荐

