Sphinx タスク

作成: Run | Edit Configurations | | Python ドキュメント | Sphinx タスク

このダイアログを使用して、 Sphinx タスクの実行/デバッグ構成を作成します。これにより、 reStructuredText 形式のファイルから、HTML などの適切な形式（例：HTML）でドキュメントを生成できます。

実行 / デバッグ構成のツリー表示には、project で使用可能な構成の管理や、デフォルトの構成テンプレートの調整に役立つツールバーがあります。

項目	ショートカット	説明
	`Alt+Insert`	実行 / デバッグ構成を作成します。
	`Alt+Delete`	選択した実行 / デバッグ構成を削除します。デフォルト設定は削除できません。
	`Ctrl+D`	選択した実行 / デバッグ構成のコピーを作成します。デフォルト設定のコピーを作成してください。
		このボタンは、一時的な構成を選択した場合にのみ表示されます。このボタンをクリックして、一時的な構成を永続的なものとして保存します。
		新しいフォルダーに移動 / 新しいフォルダーを作成します。実行 / デバッグ構成は、フォルダーに配置することでグループ化できます。フォルダーを作成するには、カテゴリ内の設定を選択し、をクリックしてフォルダー名を指定します。カテゴリだけにフォーカスがある場合は、空のフォルダーが作成されます。次に、設定をフォルダー内、フォルダー間、フォルダー外に移動するには、ドラッグまたはボタンとボタンを使用します。グループ化を解除するには、フォルダーを選択してをクリックします。
		このボタンをクリックすると、設定がアルファベット順にソートされます。

共通オプション

項目	説明
名前	実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。
Allow multiple instances	この実行構成の複数のインスタンスを並行して実行できるようにします。デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、PyCharm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。
プロジェクトファイルとして保存	実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。デフォルトでは無効になっており、PyCharm は実行構成設定を .idea/workspace.xml に保存します。

項目

説明

名前

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

Allow multiple instances

この実行構成の複数のインスタンスを並行して実行できるようにします。

デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、PyCharm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。

プロジェクトファイルとして保存

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。デフォルトの場所は .idea/runConfigurations です。ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、PyCharm は実行構成設定を .idea/workspace.xml に保存します。

Sphinx 固有の設定オプション

項目	説明
Sphinx タスク
コマンド	指定した .rst ファイルの変換に使用するコマンドを選択します。選択されたコマンドは、ドキュメントの出力形式を規定します。
入力	ソース .rst ファイルへの完全修飾パスを指定します。パスを手動で入力するか、参照ボタンをクリックして、ファイル選択ダイアログから目的の .rst ファイルを選択します。あるいは、 `Shift+Enter` を押してファイルチューザーダイアログを開くこともできます。
出力	生成されたファイルが置かれる生成されたディレクトリへの完全修飾パスを指定します。手動でパスを入力するか、参照ボタンをクリックし、ファイル選択ダイアログから目的のファイルを選択します。または、 `Shift+Enter` を押してパス選択ダイアログを開くこともできます。
オプション	このテキストフィールドに、スクリプトを起動するキーを入力します。
環境
環境変数	Click the browse button, or press `Shift+Enter` to specify the desired set of environment variables in the Environment Variables dialog. 新しい変数を作成するには、をクリックして希望の名前と値を入力します。
Python インタープリター	リストから事前設定された Python インタープリターの 1 つを選択してください。 PyCharm が古い Python バージョンのサポートを停止すると、対応する Python インタープリターはサポート対象外としてマークされます。
インタープリターオプション	このフィールドで、インタープリターに渡されるコマンドラインオプション(英語)を指定します。必要に応じて、をクリックし、エディターに文字列を入力します。
作業ディレクトリ	実行中のタスクが使用するディレクトリを指定します。デフォルトの実行 / デバッグ構成がキーボードショートカット `Ctrl+Shift+F10` によって、またはスクリプトのコンテキストメニューから実行を選択することによって作成されるとき、作業ディレクトリは実行可能スクリプトを含むものです。このディレクトリはプロジェクトディレクトリとは異なる場合があります。このフィールドを空白のままにすると、PyCharm インストールの bin ディレクトリが使用されます。このフィールドではパス変数を使用できます。
PYTHONPATH にコンテンツルートを追加する	このチェックボックスを選択すると、プロジェクトのすべてのコンテンツルートが環境変数 PYTHONPATH に追加されます。
PYTHONPATH にソースルートを追加する	プロジェクトのすべてのソースルートを環境変数 PYTHONPATH に追加するには、このチェックボックスを選択してください。
Docker コンテナーの設定このフィールドは、プロジェクトに Docker ベースのリモートインタープリターが選択されている場合にのみ表示されます。をクリックしてダイアログを開き、以下の設定を指定します。
オプション	すべてのポートを公開する: すべてのコンテナーポートをホストに公開します。これはオプション `--publish-all` に対応します。ポートバインディング：ポートバインディングのリストを指定します。 `docker run` で `-p` オプションを使用するのと同様です。ボリュームバインディング: このフィールドを使用して、特別なフォルダー (ボリューム) と、Docker デーモンが実行されるコンピューターのフォルダー間のバインドを指定します。 `-v` オプションに対応します。詳細については、「コンテナー内のデータを管理する(英語) 」を参照してください。環境変数: このフィールドを使用して、環境変数とその値のリストを指定します。 `-e` オプションに対応します。詳細については、「ENV (環境変数)(英語) 」を参照してください。実行オプション: このフィールドを使用して、 Docker コマンドラインオプション(英語)を指定します。をクリックしてテーブルを展開します。、、をクリックしてリストを作成します。

起動前

この領域では、選択した実行 / デバッグ構成を開始する前に実行するタスクを指定できます。タスクは、リストに表示されている順序で実行されます。

項目	ショートカット	説明
	`Alt+Insert`	このアイコンをクリックして、以下の利用可能なタスクのいずれかを追加します： Launch Web Browser: ブラウザーを起動するには、このオプションを選択します。開いたダイアログで、ブラウザーの種類を選択し、開始 URL を指定します。また、ブラウザーを JavaScript デバッガーで起動するかどうかも指定します。外部ツールの実行: 外部アプリケーションを実行することを選択します。開いたダイアログで、実行する 1 つまたは複数のアプリケーションを選択します。 PyCharm でまだ定義されていない場合は、その定義を追加してください。詳細については、外部ツールと外部ツールを参照してください。 Run Another Configuration: 別の実行 / デバッグ構成を実行することを選択し、それが完了するまで待ってから現在の構成を開始します。複数の構成を並行して実行する場合は、複合実行 / デバッグ構成を使用してください。 Run File Watchers ：このオプションを選択すると、PyCharm が現在アクティブなすべての File Watchers を適用します。 Run Remote External Tool: リモート SSH 外部ツールを追加します。 Grunt タスクを実行: Grunt タスクを実行するには、このオプションを選択してください。表示される Grunt タスクダイアログで、必要なタスクが定義されている Gruntfile.js を指定し、実行するタスクを選択して、Grunt ツールに渡す引数を指定します。 Node.js ランタイムの場所、それに渡すパラメーター、 grunt-cli パッケージへのパスを指定します。 Run gulp task: Gulp タスクを実行するには、このオプションを選択してください。表示される Gulp タスクダイアログで、必要なタスクが定義されている Gulpfile.js を指定し、実行するタスクを選択して、Gulp ツールに渡す引数を指定します。 Node.js ランタイムの場所、それに渡すパラメーター、 gulp パッケージへのパスを指定します。 npm スクリプトを実行: npm スクリプトを実行するには、このオプションを選択してください。開いた NPM スクリプトダイアログで、 npm 実行 / デバッグ構成設定を指定します。 TypeScript をコンパイルする: 組み込み TypeScript コンパイラーを実行するように選択し、TypeScript コードに加えたすべての変更が生成された JavaScript ファイルに反映されるようにします。表示される TypeScript のコンパイル設定ダイアログで、エラーの確認チェックボックスを選択または選択解除して、エラーが検出された場合のコンパイラーの動作を設定します。エラーの確認チェックボックスが選択されていると、コンパイラーはすべてのエラーを表示し、実行構成は開始されません。エラーの確認チェックボックスがオフの場合、コンパイラーは検出されたすべてのエラーを表示しますが、実行構成は起動されます。 Disconnect Data Source: 実行 / デバッグ構成を実行する前にデータソースへの接続を中断する場合は、このオプションを選択します。
	`Alt+Delete`	このアイコンをクリックして、選択したタスクをリストから削除します。
	`Enter`	選択したタスクを編集するには、このアイコンをクリックします。開いたダイアログで必要な変更を加えます。
	`Alt+Up` `Alt+Down`	これらのアイコンをクリックして、選択したタスクをリスト内で 1 行上または下に移動します。タスクは、リストに表示されている順に実行されます。
Show this page		実行 / デバッグ構成を実際に開始する前に、実行 / デバッグ構成設定を表示するには、このチェックボックスを選択します。
Activate tool window		デフォルトではこのチェックボックスは選択されており、実行 / デバッグ構成を開始すると実行またはデバッグツールウィンドウが開きます。それ以外の場合、チェックボックスがオフの場合、ツールウィンドウは非表示になります。ただし、設定の実行中は、 `Alt+4` または `Alt+5` を押すことで、対応するツールウィンドウを自分で開くことができます。
ツールウィンドウにフォーカス		実行 / デバッグ構成を開始したときに、実行またはデバッグツールウィンドウに自動的にフォーカスを移動させるには、このチェックボックスを選択してください。

ログ

次のオプションは、この構成の実行のログ記録に関連しています。詳細については、ログオプションの設定を参照してください。

項目	説明
Specify logs to be shown in the console	アプリケーションの実行中に表示するログファイルを指定します。をクリックして新しいログを追加します。ログファイルエイリアスの編集ダイアログで、次のように構成します。エイリアス: ログが表示されるタブの名前。ログファイルのロケーション: ログファイルまたは Ant パターン(英語)へのパスを指定します。ローリングログの複数のファイルがパターンに一致する場合、PyCharm は最新のファイルを表示します。 Show all files coverable by pattern: パターンに一致するすべてのログを表示します。テーブル内のログについては、次のオプションを構成できます：アクティブ: 指定したログファイルを表示します。内容のスキップ: 以前の実行からの古いログメッセージを表示しません。
コンソール出力をファイルに保存する	コンソール出力を指定の場所に保存します。パスを手動で入力するか、参照ボタンをクリックして表示されるダイアログで目的の場所を指定します。
Show console when a message is printed to stdout	アプリケーションが標準出力ストリームに書き込む際にコンソールを有効化します。
Show console when a message is printed to stderr	アプリケーションが標準エラーストリームに書き込む際にコンソールを有効化します。

2026 年 6 月 1 日