カスタム Sphinx ドメイン内で、別のドメイン内の別のノードへの参照を作成したいと考えています。例えば：

私example:directive::の「メソッド」はPython クラスであるbaztype の何かを返すと言います。foo.barそのため、それを他の説明と相互参照したいと思いpy:class:: foo.barます。

カスタム ドメイン内で、ディレクティブを解析して要素を構築していexampleますが、メソッドをサブクラス化することで、ドメイン内の相互参照でさえ問題なく動作しますsphinx.domains.Domain:resolve_xref。handle_signature後で別のドメインのノードに解決されるメソッドにノードをプログラムで挿入する方法がわかりません。どういうわけかインスタンス化する必要がありますsphinx.domains.python.PyXRefRoleか？

HTML で期待される結果は次のようになります。

PyCharm に Python プロジェクトがあり、Python コードとドキュメント文字列から API ドキュメントを (HTML 形式で) 自動的に生成したいと考えています。

このページによると、Python API ドキュメントを生成するツールは多数あります。

• オートサマリー
• オートドック
• pdoc
• PyDoc
• パイドクター
• ドキシジェン

このページには、次のツールが「ドキュメントを処理する」ことも記載されています。

• DocUtils
• スフィンクス

PyCharmのドキュメントには、DocUtils と Sphinx を使用して「フォーマットされた API ドキュメントを作成する」ことができると書かれています。ただし、これらのツールはファイルではなくファイルのみを処理する構成を示しているため、これは正しくないようです。*.rst*.py

私の質問はこれです: PyCharm の DocUtils または Sphinx 機能を使用して API ドキュメントを生成できますか?

それができない場合、これを行うために PyCharm の機能を使用できますか?

それができない場合、これを行うための PyCharm とうまく統合できるツールはありますか?

PyInstaller を使用して、docutils.rst が使用されている Kivy アプリケーション用の Windows exe 配布可能パッケージをビルドしています。PyInstaller .spec ファイルで console = False を設定すると、ウイルスが報告されます。console = True の場合、すべてがスムーズに実行されます。パッケージ内の docutils を除外すると、ウイルスはまったく報告されませんが、特定の docutils 機能が欠落しています。

残念ながら、PyInstaller 開発コミュニティはこれらの問題をこれ以上解決することを望んでおらず、ウイルス ソフトウェア ベンダーに問い合わせることを望んでいません。 is%3Aclosed )。もちろん、大規模で多様な企業コミュニティ向けのアプリケーションを開発する場合、これは事実上不可能です。

質問 1: 実行可能ファイルでコンソール python コンソールを無効にする方法を知っている人はいますか?

それ以外の場合は、パッケージを構築する別の方向を見つける必要があります。例: Python スクリプトをバイナリ実行可能ファイルにコンパイルする方法

質問 2: python + kivy + multiprocessing + docutils.rst parser に基づくパッケージに移行するための最良のオプションは何だと思いますか?

完全を期すために、実際の PyInstaller 仕様ファイルを追加しました。

- - モード: パイソン - -

Docutils ドキュメント ツリーでは、セクションtitle内またはドキュメント自体内にノードが発生する場合があります。

NodeVisitor私が作成している特定の Docutils について、現在のtitleノードがドキュメントのタイトルなのか、それともドキュメント内のいくつかのセクションの 1 つにあるのかを区別できるようにする必要があります。それが実際にドキュメント全体のタイトルである場合は、このタイトルをスキップして先に進みます。

私は内でこれを行うことができると思っていたでしょうVisitor.visit_title:

ただし、これは機能しません。訪問者は、別のsectionノード内でドキュメントのトップ レベルのタイトルに遭遇します。このため、上記のチェックは (正しく) の親がノードでtitleはないことを示していdocumentます。

NodeVisitor内で、titleが実際に特別なドキュメントのタイトルであることをどのように確認できますか? titleまたは、タイトルとより簡単に区別するために、実際にドキュメント レベルになるように Docutils にフックするにはどうすればよいsectionですか?

Sphinx/rst を使用して部分マークの段落をセキュリティで保護するにはどうすればよいですか?

レンダリングすると (以下を参照)、見出しはきれいに見えますが、文章はリストのように見えます。(および)文字を使用した部分マーキング情報に関する厳格な要件のため、置換/置換ディレクティブを使用することは受け入れられるソリューションではありません。

レンダリングされた出力:

Sphinx でドキュメントの各セクション名をトラバースするにはどうすればよいですか?

(そして、docutils のドキュメントはどこにありますか? Sphinx Application API以外に役立つものを見つけるのは非常に困難です。docutils/nodes.pyのソース コードを見ても、あまり役に立ちません。)

Sphinx でカスタム ロール/ディレクティブを作成しています。テキスト文字列を reStructuredText として解釈するノードを挿入する必要があります。これを行う方法はありますか？

このソースを見つけましたhttp://agateau.com/2015/docutils-snippetsは、クラスを使用docutils.nodesしてプログラムでdoctreeフラグメントを構築する方法を示しています。

私がやりたいことは次のようなものです

conf.py でこれを行うことにより:

restructuredtext で次のテーブルを定義します。

これが ( Sphinxを使用して) html でレンダリングされると、「Two options:」テキストが段落タグでラップされます。「Bar does something.」テキストは、段落タグでレンダリングされません。スタイルシートが適用されると、セル テキストの外観が異なります。

両方のケースで同じ動作を強制する方法はありますか?

docutils を使用して .ipnb ファイルを .rst に変換する既知の方法がありますが、.ipnb、.py の .rst ファイルを変換できますか?

可能であれば、例を挙げてください。