python帮助函数输出的标记语言?

时间:2012-04-26 21:57:30

标签: python

help(something)的输出是否遵循一些易于在html中格式化的标记语言?我知道pydoc -w [topic],但有两个问题:

  • 风格的定制并不容易(http://bugs.python.org/issue10716)和
  • pydoc -w某些主题失败(http://stackoverflow.com/a/10333615/1318686)

以下是help('def')生成的一些示例输出。它具有其他标记语言的一些典型特征。例如。代码块的空格,`用于内联代码,**用于突出显示...

有什么想法吗?

谢谢!

Function definitions
********************

A function definition

Multiple decorators are applied in
nested fashion. For example, the following code:

   @f1(arg)
   @f2
   def func(): pass

just like a function defined by a lambda form.  The "``def``" form is
actually more powerful since it allows the execution of multiple
statements.

**Programmer's note:** Functions are first-class

1 个答案:

答案 0 :(得分:1)

大多数人使用reStructuredText并使用Sphinx将其转换为HTML和其他格式。

虽然没有关于如何格式化函数的文档字符串的要求。