問題タブ [python-sphinx]

私は Sphinx の「マニュアル」ドキュメント クラスを使用していますが、ページ ヘッダーを除いて、Latex 出力がどのように見えるかに非常に満足しています。これには私の論文のタイトルと「Release 1」が含まれています。

私はドキュメントではなく論文を書いているので、明らかにリリース情報は必要ありません。残念ながら、Sphinx latex 出力をカスタマイズする方法に関する情報を見つけるのは非常に困難です。

誰かがそれを行う方法を知っていますか?

Django プロジェクトを文書化するために autodoc で Sphinx を使用しています。

デザイン担当者は、プロジェクトで定義されているすべてのテンプレート タグに関するドキュメント ページを必要としています。もちろん、テンプレートの処理関数をすべて手で列挙すれば、このようなページを作成できますが、DRY ではないと思いますよね。実際、テンプレート タグ処理関数はすべて@register.inclusion_tagデコレータでマークされています。したがって、何らかのルーチンでそれらをすべて収集して文書化することは可能で自然なことのようです。

フィルター機能についても同様です。

私はそれをグーグルで検索し、Djangoのドキュメントを検索しましたが、そうではありませんでした。このような自然な機能が誰かによって実装されていないことが信じられません。

私は自分のプロジェクトのドキュメントを作成するためにSphinxを使用しています。私は拡張子sphinx.ext.pngmathを使用したいと思います。この小さなテストで:

エラーが発生しました：

パッケージ texlive-latex-base をインストールしました。

ありがとう、ルービック

次のように、コンストラクターの実行の一部としてのみ宣言されるオブジェクト属性を持つPythonクラスがあります。

どちらかを使用するか、Sphinxでhelp(Foo)ドキュメント化しようとすると、属性と属性が表示されません。これは、APIのユーザーにとって問題です。Fooself.basepathself.availableruns

これらの「動的に宣言された」属性がパーサーによって検出される（そしてできればdocstringされる）ことを保証するための標準的な方法を検索しようとしましたが、これまでのところ運がありません。助言がありますか？ありがとう。

マシンのネイティブ環境ではなく、virtualenv を使用して html ドキュメントを作成したいと考えています。

virtualenv に入りましたが、実行make htmlすると、モジュールをインポートできないというエラーが表示されます。エラーは、ネイティブ環境でモジュールを使用できないことが原因であることがわかっています。ドキュメントを検索するときに使用する環境を指定するにはどうすればよいですか (例: virtualenv)?

Web サービスの文書化に Sphinx を使用しています。コード ブロック ディレクティブを使用してフォーマットされた JSON Web 応答を表示したいと思います。Spinx は Pygments を介して実行しますが、Pygments には JSON の構文ハイライターがありません。代わりにどの言語を指定することをお勧めしますか? HTML? JavaScript?

プロジェクトのドキュメントを管理するためにSphinxを使用しています。

順序付けされていないリストがあり、すべてのアイテムの最初の行をコードセグメントにします。（インラインではなく、段落です。）

どうやってやるの？

Python ライブラリの文書化に Sphinx を使用しました。これまでのところ、これはうまく機能し、素敵な HTML と LaTeX の出力が得られます。Latex に関しては、Sphinx は多くの特別なパッケージと構成を含む完全なスタンドアロン ドキュメントを生成します。

しかし、生成された Latex ファイルを既存の Latex プロジェクトに統合したいと考えています (より正確には、本の付録で)。特に、Sphinx で生成されたドキュメント ページに、親ドキュメントのヘッダー、フッター、およびセクション見出しのスタイルを持たせたいと考えています。不要なものを手動で削除し、Sphinx によって生成されたtexファイルのさまざまなオプションを調整することで、関連する部分を何らかの方法で転送できると思います。ただし、おそらくこれは非常に面倒な作業であり、多くの時間を費やします (検出して修正する必要がある競合するパッケージとオプションを考える)。

Sphinx の Latex-Builder はそのようなユースケースをサポートしていますか? そうでない場合、独立した Latex ドキュメントをマージするより一般的な方法はありますか?

ヒントをありがとう！

Sphinxドキュメントで内部ハイパーリンクを作成するにはどうすればよいですか？使ってます：

しかし、それは機能していません。

Sphinxドキュメントジェネレータでテキストの取り消し線を作成することは可能ですか？