邂逅PyDoc

最新推荐文章于 2023-09-01 19:10:11 发布
原创 最新推荐文章于 2023-09-01 19:10:11 发布
· 6k 阅读 · 0 ·
版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#restructuredtext #documentation #python #文档 #javadoc #output

先感谢 霏昀 在qq群上问了个问题:
"想pydoc用生成一个目录的文档，调哪个函数？"
这个问题我现在还答不出来.

不过我查了一下pydoc的资料,manual里居然没多少东西(其实已经讲得很清楚了,可能是习惯了,太短的东西就觉得讲得不全),发扬我一贯的作风直接看source.
pydoc太经典了,居然是用于生成python 文档的工具,
根据文件开头的注释
随手打了
pydoc -p 8070
哈哈 用浏览器看一下http://localhost:8070/  居然是python模块的文档,非常全,因为他是直接从源文件里生成的.以后可以省得乱翻source找模块和包的文件了,因为他自动生成了很好的连接,布局也不错,唯一美中不足的是页面有点丑,但是规划得不错,这个就不强求了.

译编码风格的时候还不理解什么叫docstring,现在知道了,原来可以用于生成文档的. : )

看看官方文档的描述,不过好像不是自带的那个,呆会儿我在试一下

PyPI: epydoc 2.1

A tool for generating API documentation for Python modules, based on their docstrings. Epydoc supports two output formats (HTML and PDF), and four markup languages for docstrings (Epytext, Javadoc, ReStructuredText, and plaintext).
Python文档生成工具pydoc使用介绍
12-25
在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc. pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！ 【用法】 Windows下: 复制代码 代码如下: D:\>python -m pydoc <modulename>   # 比如说: python -m pydoc math    -m参数:Python以脚本
pydoc用法
qq_30235073的博客
04-16 766
pydoc是python自带的一个文档生成工具，使用pydoc可以很方便的查看类和方法结构 本文主要介绍：1.查看文档的方法、2.html文档说明、 一、查看文档的方法 方法1：启动本地服务，在web上查看文档 命令【python3 -m pydoc -p 1234】 通过http://localhost:1234来访问查看文档 说明： 1、-p指定启动的...
pydoc是什么？
weixin_30672295的博客
12-03 496
python中pydoc模块可以从python代码中获取docstring，然后生成帮助信息。 windows环境下，命令行运行： python -m pydoc atexit Linux环境下直接运行： pydoc atexit HTML帮助 pydoc还能够生成HTML输出，既可以将HTML帮助信息输出到静态文本中，也可以启动一个Web服务器在线浏览帮助文档。 Windo...
什么是pydoc？
m0_57236802的博客
09-01 1000
pydoc是 Python 的内置文档生成器和在线帮助系统。它可以用于查看 Python 模块、类、函数和方法的文档。pydoc可以生成文本或 HTML 格式的文档，并且还可以启动一个 HTTP 服务器，以便在 Web 浏览器中查看文档。
Pydoc
OrdinaryCrazy的博客
03-26 874
python3 -m pydoc os pydoc - the Python documentation tool pydoc &lt;name&gt; ... Show text documentation on something. &lt;name&gt; may be the name of a Python keyword, topic, function, modu...
初步介绍Python中的pydoc模块和distutils模块
09-22
在这些模块中，pydoc和distutils是两个非常重要的模块，它们分别用于自动生成文档和构建和分发Python模块。 pydoc模块是Python标准库的一部分，它提供了一种简单的方式来生成和显示模块的文档。pydoc不仅可以显示...
PyDoc:Eclipse的Python文档插件-开源
05-13
PyDoc是一个简单方便的插件。 它可以节省使用Eclipse SDK和PyDev的Python开发人员的时间，而无需在开发环境和文档之间进行切换。 PyDoc Online是Python 2.6-3.3的文档的轻量级分支
Sublime3-pydoc:Sublime 3 Pydoc 插件
06-22
Sublime3-pydoc Sublime 3 Pydoc 插件。 如果使用 python 函数定义，此插件会自动完成文档字符串。 描述 DocPy 自动完成任何 python 函数定义的文档字符串，并插入可以替换的默认参数。 安装 无论哪种方式，使用包...
pydoc介绍
weixin_33958585的博客
01-26 260
  Ka-Ping Yee 曾创建了一个相当著名的模块，名叫 pydoc （比较而言： pydoc 可以做到 perldoc 所能做的任何事，并且做得更好、更漂亮:-）。对于 Python 2.1 来说， pydoc （以及它支持的 inspect ）是标准库的一部分。而对于使用 Python 1.5.2、1.6 或者 2.0 版本的用户来说，下载并安装 pydoc 也很简单 ― 请立即下载（请...
python模块大全doc_Python文档生成工具pydoc使用介绍
weixin_39795268的博客
11-24 426
在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc.pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！【用法】Windo...
pydoc模块(python自带)
YPFeime的博客
02-28 3101
项目文档注释的查看方法 条件： 1：在项目的根目录执行 python3 -m pydoc -b :使用任务未被占用的端口 或 python3 -m pydoc -p 10011 ：使用指定的10011端口 2：对于项目中的包， 包中必须有“__init__.py”文件， 才能被索引显示出来， 如果没有这个文件，pydoc ...
python doc_Python文档生成工具pydoc使用介绍
weixin_39704971的博客
11-26 363
在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc.pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！【用法】Windo...
Python文档生成工具pydoc
华秋实的专栏
06-03 2633
在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydocpydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！【用法】Windows
笔记——pydoc
excellentzzj129的博客
03-17 976
Terminal 中输入 python3 -m pydoc -p 7890，即可通过 https://localhost:7890，查看模块说明文档Terminal 中输入 pydoc input 即可在Terminal 中查看 input 说明
Python pydoc模块
wdt3385的专栏
08-02 1573
The pydoc module imports a Python module and uses the contents to generate help text at runtime. The output includes docstrings for any objects that have them, and all of the documentable contents
使用pydoc查看文档
bsbhenry的专栏
11-04 1259
pydoc模块主要用来从Python模块中提取信息并生成文档。 C:\Users\Administrator&gt;python -m pydoc -p 1104 Server ready at http://localhost:1104/ Server commands: [b]rowser, [q]uit 在浏览器输入http://localhost:1104/，即可查看python的文...
可爱的 Python: pydoc 和 distutils 模块
chenyulancn的专栏
12-19 855
 一年前，如果您问一个诚实的 Python 推广者，Python 是否缺少某些如 Perl 等其它语言所拥有的重要的东西。答案很可能会是“是”。这并不是说 Python 缺少一定范围的模块和包的支持（包括 Python 自身和扩展模块）。这当然也不是 Python 胜人一筹的明确的表达式和简洁的面向对象。 Python 是什么？ Python 是由 Guide van Rossum
Python pydoc
最新发布
03-03
### Python `pydoc` 模块概述 `pydoc` 是 Ka-Ping Yee 创建的一个著名模块，能够提供类似于 Perl 的 `perldoc` 功能，并且在许多方面表现得更加出色[^1]。该工具旨在帮助开发者快速获取有关 Python 模块的信息。 #### 使用命令行访问文档 通过命令行可以方便地调用 `pydoc` 工具来查看各种对象的帮助信息： ```bash $ python -m pydoc <module_name> ``` 这会显示指定模块的详细说明及其内部函数和类的内容。 #### 查看内置类型的文档 除了第三方库外，还可以利用此功能探索核心语言特性： ```bash $ python -m pydoc str ``` 上述指令将返回字符串类型的所有可用方法列表及相关描述。 #### 启动 HTTP 服务器浏览在线文档 为了更直观地查阅资料，也可以启动一个本地 Web 服务端口用于导航整个标准库及其他已安装包内的资源： ```bash $ python -m pydoc -p 8080 ``` 此时可以在浏览器中输入 http://localhost:8080 访问交互式的 HTML 页面形式呈现出来的 API 参考指南。 #### 编写自定义脚本来生成静态HTML文件 如果希望一次性导出所有感兴趣的项目到单个目录下，则可以通过编写简单的 Python 脚本来实现批量处理任务： ```python import pydoc modules = ['os', 'sys'] for module in modules: with open(f'{module}.html', 'w') as f: html_content = pydoc.render_doc(module, renderer=pydoc.HTMLDoc()) f.write(html_content) ``` 这段代码将会针对给定名称中的每一个创建对应的 .html 文件保存至当前工作路径之中。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值