Pythonプロジェクトを文書化するには？

Question

私は新しいPythonライブラリをプログラミングしています。そのような図書館を文書化する良い方法は何ですか？私はhtmlで完全なドキュメントを生成するメソッドを好むだろう。

Answer 1

どこでもドキュメントストリングを使用することが最初のステップです。次に、いくつかのpythonドキュメント生成ツールのいずれかを使用して、高品質のドキュメントを生成することができます。それはSphinxを使ってpython.orgがしているものです。

しかし、ドキュメンテーション文字列を使用した場合も、同様に右インタプリタでプログラマのために有用であることの余分な利点があります。

>>> help(dir) 
Help on built-in function dir in module __builtin__: 

dir(...) 
    dir([object]) -> list of strings 

    If called without an argument, return the names in the current scope. 
    Else, return an alphabetized list of names comprising (some of) the attributes 
    of the given object, and of attributes reachable from it. 
    If the object supplies a method named __dir__, it will be used; otherwise 
    the default dir() logic is used and returns: 
     for a module object: the module's attributes. 
     for a class object: its attributes, and recursively the attributes 
     of its bases. 
     for any other object: its attributes, its class's attributes, and 
     recursively the attributes of its class's base classes. 

このすべてdir()組み込み関数のドキュメンテーション文字列から来ているが、それはうまくきれいに印刷されます内蔵のhelp()機能を介して。