python doc_Python文档生成工具pydoc使用介绍
在Python中有很多很好的工具来生成字符串文档(docstring)，比如说: epydoc、doxygen、sphinx，但始终觉得pydoc还是不错的工具，用法非常简单，功能也算不错，本文主要介绍pydoc.
pydoc是Python自带的模块，主要用于从python模块中自动生成文档，这些文档可以基于文本呈现的、也可以生成WEB 页面的，还可以在服务器上以浏览器的方式呈现！
【用法】
Windows下:
复制代码 代码如下:
D:\>python -m pydoc # 比如说: python -m pydoc math
-m参数:Python以脚本的方法运行模块
Linux/Unix下:
复制代码 代码如下:
$ pydoc # 比如说: pydoc
【帮助】
复制代码 代码如下:
$ pydoc -h
pydoc - the Python documentation tool
pydoc ...
Show text documentation on something. may be the name of a
Python keyword, topic, function, module, or package, or a dotted
reference to a class or function within a module or module in a
package. If contains a '/', it is used as the path to a
Python source file to document. If name is 'keywords', 'topics',
or 'modules', a listing of these things is displayed.
pydoc -k
Search for a keyword in the synopsis lines of all available modules.
pydoc -p
Start an HTTP server on the given port on the local machine.
pydoc -w ...
Write out the HTML documentation for a module to a file in the current
directory. If contains a '/', it is treated as a filename; if
it names a directory, documentation is written for all the contents.
【参数 -p】在本地机器上，按照给定的端口启动HTTP，
复制代码 代码如下:
D:\>python -m pydoc -p 1234 #比如说: 端口为1234
pydoc server ready at http://localhost:1234/
pydoc server stopped
在IE中输入:http://localhost:1234/，效果如图:
【参数 -k】在所有可用的模块中按关键字搜索
复制代码 代码如下:
$ pydoc -k xml.sax
xml.sax (package) - Simple API for XML (SAX) implementation for Python.
xml.sax._exceptions - Different kinds of SAX Exceptions
xml.sax.expatreader - SAX driver for the pyexpat C module. This driver works with
xml.sax.handler - This module contains the core classes of version 2.0 of SAX for Python.
xml.sax.saxutils - A library of useful helper classes to the SAX classes, for the
xml.sax.xmlreader - An XML Reader is the SAX 2 name for an XML parser. XML Parsers
【参数 -w】将指定模块的文本字符串生成HTML格式
比如说，在Window下面，执行下面命令:
复制代码 代码如下:
D:\Learn\Python>python -m pydoc math -w math.html # math是模块名，-w:写
那么在D:\Learn\Python目录下会生成math.html文件，显示如下:
因为是自带的模块，所以右上角显示(built-in)字样
【例子】自写的模块my_doc.py
复制代码 代码如下:
'''''
Showoff features of Pydoc module
This is easy module to demonstrate docstrings
'''
__authors__ = 'Alice & Fred'
__version__ = 'version 1.10'
__license__ = 'Copyright...'
class MyClass:
'''''
Demonstrate Class Docstrings
'''
def __init__(self, spam=1, eggs=2):
'''''
Set the default attributevalues only
Keyword arguments:
spam - a processed meat product
eggs - a fine breakfast for lumberjacks
'''
self.spam = spam
self.eggs = eggs
def square(x):
'''''
Square of the param
'''
return x * x
执行命令:
复制代码 代码如下:
D:\Learn\Python> python -m pydoc my_doc
执行结果:
复制代码 代码如下:
Help on module my_doc:
NAME
my_doc
FILE
d:\learn\python\my_doc.py
DESCRIPTION
Showoff features of Pydoc module
This is easy module to demonstrate docstrings
CLASSES
MyClass
class MyClass
| Demonstrate Class Docstrings
|
| Methods defined here:
|
| __init__(self, spam=1, eggs=2)
| Set the default attributevalues only
| Keyword arguments:
| spam - a processed meat product
| eggs - a fine breakfast for lumberjacks
FUNCTIONS
square(x)
Square of the param
DATA
__authors__ = 'Alice & Fred'
__license__ = 'Copyright...'
__version__ = 'version 1.10'
VERSION
version 1.10
执行命令:
复制代码 代码如下:
d:\Learn\Python>python -m pydoc -w my_doc my_doc.html
wrote my_doc.html
no Python documentation found for 'my_doc.html'
执行结果:
本文标题: Python文档生成工具pydoc使用介绍
本文地址: http://www.cppcns.com/jiaoben/python/125726.html
python doc_Python文档生成工具pydoc使用介绍相关推荐
- python自带的文档生成工具_Python文档生成工具pydoc使用介绍
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc.doxygen.sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介 ...
- sphinx：基于 Python 的文档生成工具
sphinx:基于 Python 的文档生成工具 Motivation 对于软件开发来说,文档是软件可维护性的重要保障.sphinx 是一款文档生成工具,以 restructuredText 为标记语 ...
- python文档生成工具pydoc
为了找到对象及其文档内容,pydoc 会导入文档所在的模块. 因此,任何模块层级的代码都将被执行. 请使用 if name == 'main': 语句来确保一个文件的特定代码仅在作为脚本被发起调用时执 ...
- python文档生成_python文档生成工具-pydoc
为了找到对象及其文档内容,pydoc 会导入文档所在的模块. 因此,任何模块层级的代码都将被执行. 请使用 if __name__ == '__main__': 语句来确保一个文件的特定代码仅在作为脚 ...
- 关于深度学习框架Hamaa与Python API文档生成工具Sophon
五月两场 | NVIDIA DLI 深度学习入门课程 5月19日/5月26日一天密集式学习 快速带你入门阅读全文> 正文共1988个字,预计阅读时间12分钟. 前言 最近三个月我主要花时间在造 ...
- python自带的文档生成工具,Python文档生成工具pydoc
在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc.doxygen.sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介 ...
- python文档生成_python文档生成工具：pydoc、sphinx；django如何使用sphinx？
文档生成工具: 自带的pydoc,比较差 建议使用sphinx 安装: pip install sphinx 安装主题: 由各种主题,我选择常用的sphinx_rtd_theme pip instal ...
- Apiggs —— 非侵入性的 RestDoc 文档生成工具
程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一 ...
- Doxygen自动文档生成工具在Eclipse中的集成及使用举例
你有为软件编写说明文档的苦恼吗?当别人甩给你一个庞大的系统,让你根据里面的代码注释理解后写出一份完整的开发文档,你会怎么办?一个个的看代码 然后耗时N天来写吗?这既是一份苦差事也极其耗时,有没有更好的 ...
最新文章
- 使用python建立简单的树机构
- 必须认识的http请求包
- openmp并行编程_OpenMP实现生产者消费者问题
- 列表反向组成数字相加，并输出数组反向组成列表
- 通杀IIS7.0畸形解析0day漏洞
- 2021抖音汽车生态报告
- Java多线程基础总结
- textview 背景变形_嘉兴海宁市家庭别墅背景墙装修供应——零度木门厂家
- Apache Lucene 3.x推荐教程
- 安装谷歌json格式转换插件
- Java SE 常见逻辑思维题
- 非淡泊无以明志，非宁静无以致远
- 使用async.whilst要注意的地方
- 高德地图JS API 2.0绘制编辑多个矢量图形（圆形和多边形）
- 沐风：立刻改变你的现状
- 【生信】初探基因定位和全基因组关联分析
- UE4Material_RainEffect(雨的效果)
- unsupported dynamic reloc R_ARM_REL32 AND hidden symbol '__dso_handle' is not defined
- 中国AI青年科学家：当天才遇上烟火气
- MATLAB产生任意信号波形（多周期线性扫频信号）