0

の出力はhelp(something)、HTML でフォーマットしやすいマークアップ言語に従っていますか? 私は知ってpydoc -w [topic]いますが、2つの問題があります:

  • スタイルのカスタマイズは簡単ではありません (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
4

1 に答える 1

1

ほとんどの人はreStructuredTextを使用し、 Sphinxを使用して HTML やその他の形式に変換します。

ただし、関数のドキュメント文字列をフォーマットする方法に関する要件はありません。

于 2012-04-26T22:00:45.087 に答える