python-sphinx

0熱

2答えて

sphinx autodoc-skip-memberハンドラー：napoleonを使用しているときに__init __（）を表示できません

のドキュメントストリングをスフィンクスのドキュメントに含める必要があります。 autodoc-skip-memberのハンドラを追加するために私はthe accepted answer to this stackoverflow questionをフォローしていましたが、まだ__init__()のドキュメントを見ることができませんでした。 if name == "__init__":ブロック内のト

3熱

1答えて

PyQt 4の読み込みでの読み込み

私は現在、自分のコードのドキュメントをread-the-docs経由でオンラインにしていますが、PyQt4依存モジュールを処理するread-the-docsを入手するのは問題があるようです。私は、異なるモジュールのドキュメンテーション文字列のHTML表現を構築するためにスフィンクス-autodocのを使用しています pkg pkg/__init__.py pkg/modules/ pkg/m

0熱

1答えて

Sphinxのドキュメント変数

私は私のプロジェクトのいずれかのスフィンクスドキュメントを使用してドキュメントを作成していると私は、例えば、全体のdocに何回にいくつかの単語を使用しています - IPアドレス、ポート番号および時間に変更される可能性があり、他の多くのもの。なんらかの理由で変更された場合は、すべてのファイルを手動で変更するのではなく、1か所で簡単に変更したいと考えています。私が探しているのは、すべての.rstファイ

5熱

1答えて

'autodoc_default_flags'はPythonのSphinx設定でどのように機能しますか？

私はPythonクラスのドキュメントをSphinx 1.4とsphinx-apidocとsphinx.ext.autodocという拡張子を使って生成しようとしています。私はたくさんのモジュールを持っていますが、それぞれクラス名を表示するだけですが、クラス内のメソッドの完全なリスト（コード内にdocstringがあります）は表示しません。ここでは私conf.pyファイルの抜粋です： sys.pa

1熱

1答えて

Sphinx：自動投稿エントリの間に見出しを置く

私は多くの方法でクラスを文書化するためにSphinxを使用しています。私はこの方法をヘッダのように区切られたセクションにまとめたいと思います。 .. autoclass:: MyClass .. automethod:: __init__ FooBar Methods -------------- .. automethod:: foo ..

3熱

1答えて

Sphinxオートドックを使用したPythonコルーチンの文書化

最初のasyncioベースのプロジェクトをSphinxで文書化し始めました。私はいくつかの方法の前に "coroutine"という接頭辞が付いているプロジェクトがあることに気付きました。私はプロジェクトのドキュメントで同じことをしたいと思いますが、どうやって解決するのか分かりません。例えば、aiohttp's HTTP client referenceはこのことを示していますクラスaiohtt

5熱

1答えて

CMakeLists.txtとカスタムまたはローカル.cmakeファイルの文書化

プロジェクトCMakeLists.txtファイルとローカルプロジェクト.cmakeファイルを文書化する良い方法は何ですか？ 2年前の質問/回答Documenting CMake scriptsがありますが、私は本質的にここで再度尋ねています。答えには文が含まれています現在、CMake 3.0は開発中です。これは、SphinxとreStructuredTextに基づいた新しいドキュメントシステムを

1熱

1答えて

スフィンクスの文書に著作権情報を追加

0熱

1答えて

Python：検証クラスとメソッドは適切に文書化されています（型、引数、戻り値、例外）？

pep8、pyflakes、およびpylintを使用してコードを実行します。すべて私のPythonコードの内容とフォーマットを検証します。私が今探しているのは、私のPythonコードが適切かつ完全にコメントされていることを検証することです。たとえば、すべてのメソッドにコメントがあり、それらのメソッドの引数のそれぞれもコメントされ、期待されるリターンと例外があるとします。いくつかのクラスと定数とプ

0熱

1答えて

Sphinxで画像の拡張子を選択

現在、私はPythonパッケージのドキュメントをSphinxで書いています。私は使用したいベクターイメージを持っていますが、HTMLドキュメントはSVGのみを受け付けますが、PDFドキュメントはPDFファイルでのみ動作します。問題はありません、私は私の画像の両方のバージョンを持っています。私はそうのように、私のドキュメントの異なるバージョンに含める画像を選択するonlyディレクティブを使用しよう