問題タブ [autodoc]

私はスフィンクスを始めたばかりで、喜んで学びます。

さまざまな機能をファイル内のさまざまなセクションに分割したいと考えていindex.rstます。したがって、各関数には独自のヘッダーがあります。

たとえば、という名前の python ファイルがtest.pyあり、そのファイル内に 2 つの関数がある場合:

index.rsttest.py ファイル内の 2 つの関数を分離するにはどうすればよいですか?

機能を分離する方法を理解できれば、index.htmlそれは素晴らしいことです! 現在のように、以下を実行するだけでは、出力はあまりきれいではありません。

このチュートリアル、この質問、およびnumpy docstring standardを読んだにもかかわらず、sphinx autodoc で numpy docstring をうまく処理できません。

私conf.pyは持っています：

私のdocファイルには次のものがあります：

どこpython_file.pyにある：

走るmake htmlとERROR: Unknown directive type "autosummary". したがって、次のように追加autosummaryするとextensions：

私は得る：

この質問で推奨されているように、私はに追加numpydoc_show_class_members = Falseしますconf.py。

make htmlエラーなしで実行できるようになりましたが、 ParametersandReturnsセクションは numpydoc セクションとして解釈されません。

この混乱から抜け出す方法はありますか？

関数のみを含む 1 つの .py ファイルを使用して Sphinx ドキュメントを作成するにはどうすればよいですか?

:function:: console.someFunction既に docstrings を含む複数の関数を含む .py ファイルがありますが、すべての関数を作成したくありません。すべての関数を反復するためのよりスマートまたはより良い方法はありますか?

誰かが何かを SVN リポジトリにコミットする前に、Java クラスがコメントされていることを確認したいと思います。そこで、次のワークフローを実現したいと思います。

1. ユーザーがクラス内で何かを変更する
2. ユーザーがクラスをコミットしたい
3. リポジトリへのコミットを実行する前に、SVN などはクラスの前とメソッドの前にコメントがあるかどうかをチェックしpublicます (Java AutoDoc の場合)。
4. コメントがある場合 => コミット、そうでない場合はエラー メッセージを返す

どうすればこれを理解できますか？pre-commit フックについて多くのことを見つけました。しかし、コミットメッセージ/コメントが設定されているかどうかを確認することがすべてでした。

誰かがこの問題の解決策を提供できれば、とても助かります。

私が取り組んでいるプロジェクトでは、さまざまな言語 (Java、Python、C# など) の API を含むパッケージを出荷しています。これらの API はすべて、ほぼ同じドキュメントを共有していました。ドキュメントは、当社の Web サイトで PDF と HTML で別々に入手できるはずです。ユーザーは通常、興味のあるものをダウンロード/閲覧します。

現在、sdocml を使用していますが、満足していないため、より最新のツールに移行したいと考えており、Sphinx を検討しています。

Sphinxのドキュメントを見ると、次の方法が明確にわかりません。

1- 特定の API (Java API など) のドキュメントを生成するとします。

2- autodoc はどのドメインでも機能しますか?

3- ac# 拡張子はありますか?

どんな助けでも大歓迎です！

関数のサブ関数を sphinx ドキュメントに自動的に含めたいと考えています。これにはどのようなオプションがありますか?

私のコードは次のようになります

今では付属のセットにcode.rst

しかし、sphinx による出力には main 関数しか含まれていません。