2016-12-13 3 views
0

Sphinxとオートドックを使用してPythonプロジェクトをドキュメント化する場合、:Example:を使用して、モジュール/クラス/関数docstringにコードサンプルを組み込むことができます。そういうもの。オートドックdocstringでコードを実行

>>> rng = Range(0, 1000) 
>>> rng 
[0, 1000) 
>>> len(rng) 
1000 
>>> rng.start = 500 
>>> rng.start 
500 
>>> rng.end 
1000 
>>> 

これをPythonインタプリタからコピーして貼り付けました。 SphinxやAutodocにコードを実行させ、ドキュメントの出力を自動的に取得させる方法はありますか?

私の主な関心事は、コピー&ペーストコード/出力が実際の現在のコード動作と同期しなくなっていることです。

+0

あなたは正確に何を達成しようとしていますか?そのコードを実行して検証するには、 'doctest'を調べてください。そうでない場合は、あなたがしたいことを明確にしてください。 – jonrsharpe

+0

@jonrsharpe更新を参照してください。私はdoctestを見なければならないでしょう。 –

+0

@jonrsharpeあなたがあなたのコメントを回答にしたいのであれば、私はあなたに受け入れられた答えとしてあなたに信用を与えることをうれしく思います。ありがとう! –

答えて

1

標準ライブラリには、テキストファイルまたはドキュメントストリングから対話形式の例を識別、実行、および検証できるdoctestが含まれています。

関連する問題