問題タブ [python-sphinx]

私は現在、Sphinxを使用してLaTeX出力を生成しています。これは、pdftexを使用してブックスタイルの出力用にPDFに変換されます。

現在、私は通知、警告、およびその他の「警告」が、次のようなスタイルで、境界のあるボックス内に表示されています。

このようなボックスを生成するLaTeXは次のようになります。

LaTeX .styファイルには、ボックスの動作を提供する一連のコマンドがあります。

通知の周りにボックスを配置し、ボックス内の通知の種類を表す単語を表示するのではなく、警告の周囲にボックスを保持したいのですが、ボックス内の「警告」という単語を画像に置き換えます。 ：

Sphinxによってレンダリングされた\begin{notice} ... \ end {notice}ラテックスリテラルを変更することはできません（まあ、できますが、それはお尻の本当の痛みです）。ロジックを新しい\newenvironment{notice}マクロに配置したいと思います。誰かが戦略を推薦できますか？私がこれまでに試したことはすべて涙で終わった。

このコードが私のドキュメントのブロッククォートである場合、ドキュメントが生成されたときにSphinxにそれを実行させるために何をする必要がありますか？追加してみました

ソースの1つと.rstSphinxdoctest拡張機能にconf.py。しかし、関数本体の最初の行に予期しないインデントがあるというエラーが発生しました。Sphinxのdoctestは、ドキュメントで定義されている関数を実行できますか？

sphinx-quickstartを使用してSphinxドキュメントを作成しました。

1. 外観のカスタマイズに関する良い例/チュートリアルはありますか？具体的には、ヘッダーを変更してロゴを追加します。

2. ダウンロード可能なSphinxドキュメントを含むプロジェクトはありますか？彼らがどのように彼らの外見をカスタマイズしたかを見たいです。

更新：ロゴの追加はデフォルトの設定でサポートされていますが、特に十分に文書化されていません。設定を探してくださいconf.py。`*_logo

Sphinxは、 Tracの対応するチケット/チェンジセットのよう#112なテキストを自動的にリンクする方法はありますか？r1023

例：

その他の例については、 TracLinksを参照してください。

このチャップの投稿と同様に、Sphinx が読み取り不能なグラフビズ出力を生成するのを見ています。

読み取り可能な出力を生成するにはどうすればよいですか?

• 追加しても何も起こりません-Gfontsize=140
• neato代わりに使用するように指示するとdot、読み取り可能な出力が生成されますが、グラフはツリーのようではありません。

そのため、Javadoc スタイルのドキュメントにはある程度慣れてきました。Python コードのさまざまな例を調べてみると、一見したところ、ドキュメンテーションには多くの情報が欠けているように見えます。

良い点: 自明なドキュメントを目にすることはめったにありません。Docstrings は通常、英語のマークアップの 1 段落以下であり、別々の行で目立つのではなく、統合されています。

悪い点: Python のダックタイピングと関連して、多くの関数が期待するパラメーターについて不明確であることがわかりました。型のヒント (ダック ヒンティング?) はありません。多くの場合、パラメーターはリストのように、文字列のように、ストリームのようにする必要があります。

もちろん、Javadoc は、Python の優れたイントロスペクション機能を持たない下位レベルの言語用に設計されています。

Python ドキュメントの標準とベスト プラクティスに関するアドバイスはありますか?

DRYを適用するために、パラメーターを宣言するのと同じ行に（必要に応じて）各パラメーターを文書化することを好みます

私がこのようなコードを持っている場合：

doc文字列でパラメーターを繰り返さないようにし、パラメーターの説明を保持するにはどうすればよいですか？

避けたい：

これは、Python2.6またはPython3で、ある種のデコレータ操作を使用して可能ですか？他に方法はありますか？

Sphinxを使用していくつかのドキュメントを書いていますが、特定のテキスト ブロックを HTML ドキュメント用にのみ出力したいと考えています。LaTeX ドキュメント用ではありません。これを行うことができるはずだと何かが教えてくれますが、sphinx.ext.ifconfig方法がわかりません。誰もこれを行う方法を知っていますか?

sphinx から生成された LaTeX ファイルをビルドすると、TOC エントリとセクション ヘッダーが青色になります。これらのアイテムの色付けを無効にする簡単な方法はありますか? そうでない場合、代わりにそれらを黒くする簡単な方法はありますか? 私の目標は、ドキュメントをカラー以外のプリンターで印刷することです。そうすると、TOC と見出しが残りのテキストほど暗く見えません。

可能であれば、文書全体に適用される 1 つの変更を加えたいと考えています。

注: howto ドキュメント クラスを使用しています。

アップデート

ddbeck の意見のおかげで、sphinx.styどの色を変更する必要があるかを詳しく調べました。次のようにlatex_elements辞書を設定 (作成) しました。conf.py

これはまさに私が望んでいたとおりに機能しました。ありがとうございます！

SphinxPythonドキュメントジェネレーターを使用しています。PDFドキュメントの作成は非常に簡単でシンプルですが、問題が1つあります。

生成されたすべてのPDFドキュメントには、「chapter」、「release」、「part」などの英語の単語が含まれています。

これらの英語のラベルを別の言語で上書きしたり、完全に削除したりするにはどうすればよいですか？