PyCharm 2020.1ヘルプ

リファレンスドキュメントを生成する

PyCharmは、次のドキュメントジェネレータを使用して、書式設定されたAPIドキュメントを作成できます。

次の点に注意してください。

  • ドキュメント生成プログラムは、マシンに正しくインストールされている必要があります。詳細については、それぞれのダウンロードおよびインストールページを参照してください。

  • PyCharmはドキュメントストリングフォーマットを認識し、設定ダイアログのPython 統合ツールページで定義されているドキュメントソースディレクトリを使用します。

DocUtilsを使用したリファレンスドキュメントの生成

docutilsのドキュメントを生成するには

  1. DocUtilタスク実行/デバッグ構成を選択し、必要に応じて変更します。構成名、入出力ディレクトリ、およびオプションのキーを指定します。

  2. セクションアプリケーションを実行するに従って、この実行/デバッグ構成を起動します。

Sphinxを使用したリファレンスドキュメントの生成

Sphinxドキュメントの初期インフラストラクチャを作成するには

  1. Sphinxパッケージがプロジェクトインタープリター(設定/環境設定 | プロジェクト<プロジェクト名> | プロジェクト・インタープリター)とともにインストールされていることを確認してください。PyCharmにパッケージをインストールする方法の詳細については、パッケージのインストール、アンインストール、およびアップグレードを参照してください。

  2. メインメニューでツール | Sphinxクイックスタートを選択します。

  3. Sphinx 作業ディレクトリPython 統合ツールページで指定されていない場合は、作業ディレクトリの設定ダイアログボックスが開き、ドキュメントへのパスを指定するように指示されます。
    py sphinx working directory
  4. PyCharmで開くコンソールで、sphinx-quickstart(英語)ユーティリティが提供する質問に答えます。特に、生成された conf.py ファイルが格納されるソースディレクトリを指定します。この質問に答えた場合、Enterを押すだけで、PyCharmは前の手順で指定したパス、またはPython 統合ツールページのSphinx 作業ディレクトリフィールドで指定されたパスのいずれかを使用します。

Sphinxのドキュメントを生成するには

  1. Sphinxタスクの実行/デバッグ構成を選択し、必要に応じて変更します。設定名、入力および出力ディレクトリを指定します。

  2. セクションアプリケーションを実行するに従って、この実行/デバッグ構成を起動します。

最終更新日: 2020年7月6日

関連ページ:

Python 統合ツール

このページを使用して、要件管理ファイル、デフォルトのテストランナー、およびドキュメントストリング処理を構成します。パッケージ要件ファイル要件ファイルの名前を入力するか、または参照ボタンをクリックして、パスの選択ダイアログを使用してファイルシステムから必要な要件ファイルを選択します。Pipenv 実行...

実行/デバッグ構成: DocUtilタスク

この機能はPyCharmのEducationalエディションでは利用できません。このダイアログを使用して、DocUtilsタスクの実行/デバッグ構成を作成します。これにより、reStructuredText形式のファイルから、妥当な形式(HTMLなど)でドキュメントを作成できます。DocUtilsの...

アプリケーションを実行して再実行する

PyCharmを使用すると、特定のスクリプトだけでなくアプリケーション全体を実行することができます。PyCharmは、実行/デバッグ構成で定義されている設定を使用します。プロジェクトに存在するすべての実行構成は、実行/デバッグ構成を選択しますリストで利用可能です。現在実行中のすべてのアプリケーション...

パッケージのインストール、アンインストール、およびアップグレード

PyCharmは、特定のPythonインタープリター用にPythonパッケージをインストール、アンインストール、およびアップグレードするための方法を提供します。デフォルトでは、PyCharmはプロジェクトパッケージの管理にpipを使用します。Conda環境では、condaパッケージマネージャーを使う...

ドキュメントコメントを作成する

Python関数のドキュメントコメントの作成:Python関数のドキュメントコメントを作成するには文書化したい関数の宣言の後にキャレットを置きます。三重引用符を開いて入力し、または を押します。パラメータと戻り値の意味のある説明を追加します。次の点に注意してください。開始三重引用符を入力した後に

docstringで型を指定する

導入:あなたのコードを永久にデバッグし、今デバッグの過程でまた型情報を集めそしてdocstringsでこれらの型を指定することができます。PyCharmは、実行時に型情報を収集し、型指定を定義することを可能にするインテンションアクションを提供します。ただし、デバッガを使用せずにパラメータの種類を手動...