【vscode】 rstファイルのプレビュー

rst形式のファイルをVS Code上でPreviewする方法について．この記事では，sphinxで構成したrstファイルを，VS CodeでリアルタイムにPreviewする方法を解説する．最終的には以下のような状態を目指す．

拡張機能の紹介

今回利用する拡張機能は以下の3つ．プレビューだけならEsbonioだけインストールすれば良いが，残りの二つもrstを書くときに有用なので合わせてインストールすることをお勧めする．マーケットプレイスおよびドキュメンテーションへのリンクは以下の通り．

• Esbonio [marketplace] [hp]
• reStructuredText [marketplace] [hp]
• reStructuredText Syntax Highlighting [marketplace] [hp]

Esbonio

EsbonioはSphinxをバックエンドとして利用し，RST文書のリアルタイムプレビューやコード補完を提供する拡張機能である．主な機能としてSphinxに基づくプレビューの表示やコード補完がある．プレビューは裏側でPythonおよびSphinxを利用してEsbonioがファイルをビルドして表示する仕組みになっており，利用時はこの二つが入っていることが前提となる．

reStructuredText

reStructuredText拡張はRST文書の構文チェックやナビゲーション補助を提供する総合的なツールである．主な特徴として，コードスニペットやリンター機能がある．

reStructuredText Syntax Highlighting

reStructuredText Syntax Highlightingは、構文ハイライトを提供する拡張機能である．基本的にはVS Codeにデフォルトで採用されているが，market placeから導入すると最新版が入るので一応入れておく．

プレビューする手順

上で述べた3つの拡張機能をインストールすれば，追加でsettings.jsonへの設定は不要だ．プレビュー時にはrstファイルを開いて，以下の手順を実行する．

1. Python: Select Interpreterから所望の環境を選択する．

   cmd+Shift+PからPythonと検索し，Select InterpreterからPython環境を選択する．

   

2. rst文書で右上のプレビューマークを押す．

   右上のプレビューのボタンを押すと，左右にペインが分かれて右側に文書プレビューが表示される．

   

まとめ

rst文書のプレビュー方法を紹介した．rst形式はmarkdown形式とは異なるものの構造化文書を書くときの有力な選択肢であり，特にSphinxを用いたコードのドキュメント生成は多くのOSSで採用されている．プレビューを用いて効率的にドキュメンテーションを行う一助としたい．