問題タブ [python-sphinx]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python - テキスト ファイルを *そのまま* (Python) Sphinx Docs に含める
(Python-Sphinx ドキュメンテーション ツールを使用)
unaltered.txt
に組み込みたいログ ファイルがあります。、などで何を変更する必要がありますか?_build/html
conf.py
index.rst
レイアウトは次のとおりです。
どうすればsomefile.txt
html ビルドに入ることができますか? に次のような行を追加してみましたindex.rst
:
魔法でうまくいくことを願っていますが、ここでは魔法はありません!
これが可能であると仮定すると、some_doc.rst
そのファイルを参照/リンクするには何を入れますか?
注: はい、/staticに配置してそのまま実行できることは承知していますが、それは完全なハックのようで、醜いようです。
python - Sphinx の「予期しないセクション タイトル」 - 問題は numpy ですか?
実行時
私のdoc/
ディレクトリでは、次の出力が得られます。
このファイルにはインポートがあり、少し調査したところ、sphinx が使用する RST マークアップの文書化numpy
の方法に問題があるようです。numpy
numpy インポートを取り出すと、html が正常にビルドされます。
この問題を解決する最善の方法は何ですか?
python - Sphinx を使用してプロジェクトとモジュールをオンデマンドで文書化する
私は Python モジュールのドキュメント化にSphinxを使用しています。メイン ファイルに含める個々のファイル (モジュール コンポーネントごとに) を配置するマスターdoc
ディレクトリがあります。これはうまく機能します ( Python ライブラリ リファレンスのソースを参照して、私のやり方を正確に確認してください)。*.rst
index.rst
私の問題は、(モジュール全体ではなく) 特定のモジュール コンポーネントのスタンドアロン PDF を作成する必要がある場合です。
完全なモジュール (ライブラリ) のPython ライブラリ リファレンスと同じ構造を持っているとします。次に、crypto
コンポーネントなどのドキュメント用のスタンドアロン PDF を作成します。あなたならどうしますか?
- 別のインデックスを作成し (
index_2.rst
)、そのファイルのみを含める (crypto.rst
) - 元のファイルから他のファイルをコメントする
index.rst
crypto
スタンドアロンの Sphinx ドキュメントを使用して、まったく新しい doc ディレクトリを作成します
これらのアプローチはどれも単純ではないようです。
アドバイスをお願いします。
python - Sphinx ドキュメントに PDF を含める方法は?
私が持っているパッケージのSphinxドキュメントの例について、詳細な説明が記載されたPDFがあります。自分のプロジェクトに PDF を簡単に含める方法はありますか (そして、ドキュメントをビルドするときにコピーします)。:doc: でリンクしようとしましたが、コピーされませんでした。
python - パッケージをPyPiに送信するにはどうすればよいですか?
私は小さなモジュールを書きました、そして私はそれをpypiに送るためにそれをパッケージ化するための基本的なステップが何であるか知りたいです:
- ファイル階層とは何ですか?
- ファイルにどのように名前を付ける必要がありますか?
- distutilsを使用してPKG-INFOを作成する必要がありますか?
- ドキュメント(スフィンクスで作成)はどこに含める必要がありますか?
python - Python Sphinx autodoc と装飾されたメンバー
Sphinx を使用して Python クラスを文書化しようとしています。私は autodoc を使用してそうします:
私のメソッドのdocstringを正しくフェッチしますが、装飾されたものは次のとおりです。
@checkStale
ありながら
などの間違ったプロトタイプを持っているopen(*args, **kwargs)
。
どうすればこれを修正できますか? @wraps
を使用すると、このようなことが修正されるという印象を受けました。
html - sphinx、restructuredtext:1つの単語の色を設定します
スフィンクスの単一の単語(または文字)の色を設定する方法はありますか?HTMLのタグのようなマークアップタグがあるはずですfont
。
html - HTMLの双方向性
Sphinxを使用して、 https: //bitbucket.org/omidraha/pylearn/でpylearnドキュメントのコンテンツを編集しています。
すべての段落は右から左(ペルシア語のため)であり、テキスト間のコードサンプルが正しくレンダリングされていません。
一般的に、私はWebページにUnicodeまたはMicrosoftの双方向アルゴリズムを適用する方法を探しています。
コードのcssスタイルをRTL段落内のLTRに設定する方法はありますか?そうでない場合、たとえばフレームなどで個別のコードサンプルを実行するようにsphinxソースを変更するにはどうすればよいですか?
python - Sphinxautodoc-skip-memberを私の関数に接続します
sphinxのautodoc-skip-memberイベントを使用して、ドキュメント用に特定のpythonクラスのメンバーの一部を選択したいと思います。
しかし、それはスフィンクスのドキュメントからは明らかではなく、私はそれを説明する例を見つけることができません:これを接続するためのコードをどこに置くのですか?Sphinx.connectが表示され、conf.pyに含まれていると思われますが、conf.pyでこのコードのバリエーションを試してみると、connect()する必要のあるアプリオブジェクトが見つかりません。
簡単な例へのポインタが理想的です。
python-sphinx - Sphinxで、大きなオーバーヘッドなしにリンク可能な「用語」セクションを作成するにはどうすればよいですか?
使用している用語の定義を含む「用語」セクションを作成して、この用語セクションの用語を使用するたびに、その定義を指すリンクが作成されるようにします。
現在、私が考えることができる最高のものは次のとおりです。
その後、他のテキストで私はしなければなりません:
上記の構文は非常に面倒だと思います。スクリプトまたはm4のさらに別のレイヤーを使用してこの構文を自動生成できることはわかっていますが、もっと良い方法があることを望んでいます。