問題タブ [python-sphinx]

私は、C または PHP コードのドキュメントを作成するために Doxygen が好きです。/* .. */私は近日中に Python プロジェクトを予定していますが、Python にはコメントがなく、独自の自己文書化機能も備えていることを覚えていると思います。

私は Doxygen に精通しているので、それを使用して Python ドキュメントを作成するにはどうすればよいですか? 特に注意しなければならないことはありますか？

私は個人的なプロジェクトを開始しており、フランス語を話す仲間と英語を話す他の仲間にドキュメントを提供したいと考えています。

では、ディレクトリをどのように整理すればよいでしょうか?

何を分離する必要がありますか (ソース、生成されたナビゲーション リンクの言語などのいくつかの conf 項目だと思います...)?

分離してはいけないもの (重複を避けるための構成アイテムの最大数) は?

Sphinxに組み込まれていますか?

プロジェクトの文書化にSphinxを使用しています。reStructuredTextから LaTeX ファイルを生成します。

ヒントとメモにグレーの背景色を設定したいので、グレーボックス環境を作成した後、通知環境をカスタマイズしました。

図環境を通知環境内に配置する場合を除いて、すべて正常に動作します。その場合、次のエラーが発生します。

LaTeX エラー: 外部パー モードではありません

その通知環境に灰色の背景を設定する方法はありますか?

年の初めに Sphinx の使用を推奨した人はごくわずかでした。

Sphinx は最近かなり急速に発展しました。私は今日、Sage が LaTex による直接編集から Sphinx への変更を行ったことに言及しました。これは、Sage のチュートリアルに関する 4 月 2 日の William Stein の回答で明らかです。

チュートリアルはもはやラテックス ドキュメントではありません。PDFを出力できる全く別のSphinxドキュメントです。

スフィンクスは私に相応しいレベルにあるのではないかと示唆している。

マニュアルや本を書く上で、Sphinx は LaTex より優れていますか?

ReSt (UTF8) のドキュメントがあり、sphinxを使用して HTML および latex ファイルを生成しています。（html変換は問題ありません）

次に、結果のラテックス ファイルを PDF に変換します。現在、MiKTeX 2.7 の pdflatex.exe コマンドを使用してこの変換を実行しています。(日本語の文字を含まないソース ファイルを変換すると、期待される pdf が正しく生成されます)

MiKTeX Package Manager を使用して、cjk 関連のパッケージ (cjk-fonts、miktex-cjkutils-bin-2.7、および cjk) をインストールしました。

デバッグするには、次のサンプルを使用しています。

このファイルに対して pdflatex.exe を実行すると、次の出力が生成されます。

MiKTeX/pdflatex.exe を使用して、結果の pdf に日本語を正しく表示するにはどうすればよいですか?

スフィンクスを使用して画像/図のキャプションを自動的に生成する方法はありますか？

現在、sphinxを使用してhtmlおよび（latex）pdfに変換しているrest-sphinxファイルがあります。

結果のhtml/pdfファイルで特定の画像をユーザーが簡単に参照できるようにしたいと思います。たとえば、ユーザーが電子メールのドキュメントを参照している場合、「「画像65」ではXXXと表示されますが、これは機能しません」。

画像にキャプションを付けることができるように見える図を使用してみましたが、これは手動で追加する必要があります。（そして、私はそれを何らかの理由で置換で動作させるのに問題があります）。

これを達成するために私が見落としているrest-sphinxメソッドはありますか？または、この機能を追加するためにsphinxの既存のテンプレートを変更/編集する方法はありますか？

Sphinxは、Python 用の新しいドキュメント ツールです。とても素敵に見えます。私が疑問に思っているのは：

• これは C++ プロジェクトの文書化にどの程度適していますか?
• 既存のドキュメント (doxygen など) を Sphinx 形式に変換するツールはありますか?
• Sphinx を使用する C++ プロジェクトのオンライン/ダウンロード可能な例はありますか?
• Sphinx を使用したことがある人からのヒントはありますか?

Sphinx は、いくつかの出力形式をサポートしています。

• 複数の HTML ファイル (htmlまたはを使用dirhtml)
• .pdf作成や作成に役立つラテックス.ps
• 文章

代わりに、Microsoft Word ファイルで出力を取得するにはどうすればよいですか?

別のドキュメント ジェネレーターを使用して、単一の html 出力ファイルを生成し、Word アプリケーションを使用して Microsoft Word 形式に変換することができました。

残念ながら、Word または HTML の単一ページ形式を生成する方法がわかりません。