問題タブ [python-sphinx]

(Python-Sphinx ドキュメンテーション ツールを使用)

unaltered.txtに組み込みたいログ ファイルがあります。、などで何を変更する必要がありますか?_build/html conf.pyindex.rst

レイアウトは次のとおりです。

どうすればsomefile.txthtml ビルドに入ることができますか? に次のような行を追加してみましたindex.rst:

魔法でうまくいくことを願っていますが、ここでは魔法はありません!

これが可能であると仮定すると、some_doc.rstそのファイルを参照/リンクするには何を入れますか?

注: はい、/staticに配置してそのまま実行できることは承知していますが、それは完全なハックのようで、醜いようです。

実行時

私のdoc/ディレクトリでは、次の出力が得られます。

このファイルにはインポートがあり、少し調査したところ、sphinx が使用する RST マークアップの文書化numpyの方法に問題があるようです。numpynumpy インポートを取り出すと、html が正常にビルドされます。

この問題を解決する最善の方法は何ですか?

私は Python モジュールのドキュメント化にSphinxを使用しています。メイン ファイルに含める個々のファイル (モジュール コンポーネントごとに) を配置するマスターdocディレクトリがあります。これはうまく機能します ( Python ライブラリ リファレンスのソースを参照して、私のやり方を正確に確認してください)。*.rstindex.rst

私の問題は、(モジュール全体ではなく) 特定のモジュール コンポーネントのスタンドアロン PDF を作成する必要がある場合です。

完全なモジュール (ライブラリ) のPython ライブラリ リファレンスと同じ構造を持っているとします。次に、cryptoコンポーネントなどのドキュメント用のスタンドアロン PDF を作成します。あなたならどうしますか？

1. 別のインデックスを作成し ( index_2.rst)、そのファイルのみを含める ( crypto.rst)
2. 元のファイルから他のファイルをコメントするindex.rst
3. cryptoスタンドアロンの Sphinx ドキュメントを使用して、まったく新しい doc ディレクトリを作成します

これらのアプローチはどれも単純ではないようです。

アドバイスをお願いします。

私が持っているパッケージのSphinxドキュメントの例について、詳細な説明が記載されたPDFがあります。自分のプロジェクトに PDF を簡単に含める方法はありますか (そして、ドキュメントをビルドするときにコピーします)。:doc: でリンクしようとしましたが、コピーされませんでした。

私は小さなモジュールを書きました、そして私はそれをpypiに送るためにそれをパッケージ化するための基本的なステップが何であるか知りたいです：

• ファイル階層とは何ですか？
• ファイルにどのように名前を付ける必要がありますか？
• distutilsを使用してPKG-INFOを作成する必要がありますか？
• ドキュメント（スフィンクスで作成）はどこに含める必要がありますか？

Sphinx を使用して Python クラスを文書化しようとしています。私は autodoc を使用してそうします:

私のメソッドのdocstringを正しくフェッチしますが、装飾されたものは次のとおりです。

@checkStaleありながら

などの間違ったプロトタイプを持っているopen(*args, **kwargs)。

どうすればこれを修正できますか? @wrapsを使用すると、このようなことが修正されるという印象を受けました。

スフィンクスの単一の単語（または文字）の色を設定する方法はありますか？HTMLのタグのようなマークアップタグがあるはずですfont。

Sphinxを使用して、 https： //bitbucket.org/omidraha/pylearn/でpylearnドキュメントのコンテンツを編集しています。

すべての段落は右から左（ペルシア語のため）であり、テキスト間のコードサンプルが正しくレンダリングされていません。

一般的に、私はWebページにUnicodeまたはMicrosoftの双方向アルゴリズムを適用する方法を探しています。

コードのcssスタイルをRTL段落内のLTRに設定する方法はありますか？そうでない場合、たとえばフレームなどで個別のコードサンプルを実行するようにsphinxソースを変更するにはどうすればよいですか？

sphinxのautodoc-skip-memberイベントを使用して、ドキュメント用に特定のpythonクラスのメンバーの一部を選択したいと思います。

しかし、それはスフィンクスのドキュメントからは明らかではなく、私はそれを説明する例を見つけることができません：これを接続するためのコードをどこに置くのですか？Sphinx.connectが表示され、conf.pyに含まれていると思われますが、conf.pyでこのコードのバリエーションを試してみると、connect（）する必要のあるアプリオブジェクトが見つかりません。

簡単な例へのポインタが理想的です。

使用している用語の定義を含む「用語」セクションを作成して、この用語セクションの用語を使用するたびに、その定義を指すリンクが作成されるようにします。

現在、私が考えることができる最高のものは次のとおりです。

その後、他のテキストで私はしなければなりません：

上記の構文は非常に面倒だと思います。スクリプトまたはm4のさらに別のレイヤーを使用してこの構文を自動生成できることはわかっていますが、もっと良い方法があることを望んでいます。