PyCharm 2024.3 ヘルプ

外部ドキュメント

外部ドキュメント

Python 外部ドキュメントを表示するには、最初にドキュメントの URL を構成する必要があります。PyCharm には、pandas、wx、kivy、PySide、PyQt5、PyQt4、matplotlib、pyramid、flask、gtk の URL が付属しています。事前定義された URL のセットを変更するか、プロジェクト設定に新しい URL を追加できます。

Configuring external documentation

詳細は、外部ドキュメントを設定するを参照してください。

項目

説明

モジュール名

この列には、モジュールの名前が表示されます。これらのモジュールのドキュメントは、表示 | 外部ドキュメントを呼び出すとき、または Shift+F1 を押すときにブラウザーに表示する必要があります(例: pandas)

URL パターン

この列には、外部ドキュメントへの URL、またはそのローカルアドレスへの既存のパターン(https://pandas.pydata.org/pandas-docs/stable/generated/{element.qname}.html など)が表示されます。

外部のドキュメントがローカルにある場合は、そのドキュメントへのローカルパスを指定します。

the Add button

新しいモジュールとその URL パターンまたはローカルアドレスをリストに追加するには、このボタンをクリックします。

the Edit button

このボタンをクリックして、選択したモジュールの名前または URL パターンを変更します。

テーブル内のエントリをダブルクリックすると、同じ結果が得られます。

the Remove button

選択したモジュールをリストから削除します。

ドキュメント URL の追加 / 編集

項目

説明

モジュール名

テキストフィールドにモジュール名を入力します。

URL パターン

このテキストフィールドで、使用可能なマクロフィールドのプレーンテキストとマクロを使用して、目的のパターンを作成します。

Modifying the URL for the matplotlib documentation

各ドキュメントモジュールはそれぞれ固有の構造を持っているため、マクロを追加するときは注意してください。

挿入

選択したマクロをパターンに追加するには、このボタンをクリックします。