reStructuredText サポート
reStructuredText Docstring 形式 (PEP 287) のサポートに加え、PyCharm は restructured text 用のエディターを提供します。
Markdown エディターと同様に、reStructuredText ファイルを変更して、プレビューパネルで結果を確認できます。
再構成されたテキストを使用して既存のファイルを開くか、最初から新しいファイルを作成することができます。
.rst ファイルを作成する
プロジェクト ツールウィンドウを右クリックし、 を選択します。 開いたダイアログで、任意のファイル名を .rst 拡張子で指定し、 OK をクリックします。
PyCharm はファイルタイプを認識し、対応するアイコンでマークします。
新しく作成されたファイルがエディターで開きます。
コンテンツを追加して、PyCharm が再構成テキストの編集をどのように支援するか見てみましょう。
テキストを編集する
設定 ダイアログ (Ctrl+Alt+S) で、reStructuredText () のデフォルトの配色を確認します。 必要に応じて、マークアップ要素の代替色と効果を設定します。
OK をクリックして変更を保存し、ウィンドウを閉じます。
セクション構造マークアップを追加し、結果をプレビューします。
.. code-block:: ディレクティブを使用してコードフラグメントを追加します。 PyCharm はディレクティブ名のコード補完をサポートしています。
ディレクティブで特定の言語を指定することにより、コード構文のハイライトを有効にできます: .. code-block:: python 。 また、プロジェクトインタープリターに Pygments パッケージが インストールされていることを確認してください。
テキスト内のリンクをすばやくマークアップし、参照ターゲットの追加を延期することができます。 PyCharm は参照が不足しているリンクを通知し、ハイライトします。
必要なのは、適切なターゲット参照を reStructuredText ファイルに追加するだけです（例: .. _pytest: https://docs.pytest.org/ ）。