問題タブ [python-sphinx]

スフィンクスを使用しています。テンプレートにしたい。ドキュメントを読んだ後、私が試しているのは、conf.pyで、

私は次のような行を入れます、

そして私はファイルを作成しました

ただし、これは sphinx が提供するデフォルトのテンプレートを上書きしません。さらに何をすればよいですか? また、このテンプレートはどこに移動する必要がありますか?

編集：

コメントからのディレクトリ構造:

Sphinxとautodoc 拡張機能を使用して、Python モジュールの API ドキュメントを生成しています。特定のパラメーターを適切に文書化する方法はわかりますが、**kwargsパラメーターを文書化する方法の例を見つけることができません。

これらを文書化する明確な方法の良い例はありますか?

Python プロジェクトの文書化に Sphinx を使用しています。私は autodoc 拡張機能を有効にしており、ドキュメントには次のものがあります。

問題は、クラス内の非プライベート メソッドのみを文書化することです。プライベートメソッドも含めるにはどうすればよいですか?

djangoをセットアップしようとしていました。私はDjango-1.1-alpha-1を持っています。makeユーティリティを使用してDjango-1.1-alpha-1/docにあるドキュメントを作成しようとしました。

しかし、私はいくつかのエラーが発生しています

この問題を解決してHTMLドキュメントを作成する方法を知っている人はいますか

ありがとうJ

Sphinx を使用して、さまざまなサーバーにデプロイされる Web サービスを文書化しています。ドキュメントには、ユーザーがクリックする URL の例がたくさんあり、それらはそのまま機能するはずです。私の問題は、ホスト、ポート、および展開ルートが異なり、展開ごとにドキュメントを再生成する必要があることです。

私はこのような置換を定義しようとしました:

しかし、生成された HTML は私が望むものではありません (生成されたリンクに「/path」が含まれていません):

これを回避する方法を知っている人はいますか？

作業中のPythonモジュールとクラスを文書化するためにSphinxをインストールしました。マークアップ言語は非常に見栄えがしますが、Pythonコードを自動文書化することはできませんでした。

基本的に、私は次のPythonモジュールを持っています：

そしてそれに呼ばれるクラスSeg。生成されたSphinxドキュメント内のクラスとモジュールのドキュメント文字列を表示し、さらにフォーマットされたテキストを追加したいと思います。

私index.rstはこのように見えます：

およびchapter1.rst：

ただしSeg、太字で印刷されているだけで、クラスの自動生成されたドキュメントにはリンクされていません。

次のことも役に立ちませんでした。

編集：SegLibをセグメントに変更し（ありがとう、iElectric！）、chapter1.rstを次のように変更しました：

それでも、Sphinxにクラス内の関数を直接ドキュメント化させることはできません。つまり、クラス内のすべての関数をドキュメントに自動的に追加することはできません。試した：

そして得た：

短いコマンドで関数とクラスを自動文書化する方法はありますか？

これは、 Sphinxに関する以前の質問の一般化されたバージョンです。

クラスと関数を含むモジュールまたはパッケージを再帰的に自動文書化する方法はありますか？

関数ごとにautofunctionorディレクティブを追加するのはばかげていると思います。automoduleプロセスを自動化する方法が必要です。そうしないと、Sphinxを使用する意味がまったくわかりません。

明確化： 代わりに：

すべてのメソッド名を手動でカットアンドペーストし、それに応じてドキュメントを更新する必要があるため、次のようなコマンドが必要です。

Sphinxにはautomethod、メソッドのdocstringからドキュメントを抽出し、それをドキュメントに埋め込むという機能があります。ただし、docstringだけでなく、メソッドのシグネチャ（名前+引数）も埋め込まれます。docstringのみ（メソッドシグネチャを除く）を埋め込むにはどうすればよいですか？

参照：http ：//www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

今日は Sphinx ホームページの検索機能をうまく使えなかったので、この質問はさらに難しくなりました。

docstring から文書化したいモジュールのグループがあります。ただし、これらは純粋な Python スクリプトではありません。実行スコープで新しい変数を作成する C# アプリケーションから実行されるため、そのままではコンパイルされません。

Python コンパイラには、未定義のメソッドがあるように見えます (技術的には、C# が IronPython スクリプト エンジンを作成し、メソッドを作成するまではそうです)。

私が実行すると：

私は得る：

Sphinx にコンパイル エラーを無視させ、ドキュメントを生成させるにはどうすればよいですか?

編集：

Sphinx に代わるもの (Epydoc など) が Python スクリプトをコンパイルして関数のシグネチャと docstring を取得する必要がないかどうかを誰かが知っていれば、それも役に立ちます。Sphinx は最も見栄えの良いドキュメント ジェネレーターですが、必要に応じて使用を中止します。

コードのロードをドキュメント化し、sphinxを使用してドキュメントを生成する方法を学びました。それをGitHubプロジェクトページに含めたいのですが、その方法がわかりません。誰かが既存のチュートリアルまたはそうするための簡単なステップを知っていますか？