インストール

このエクステンションは、極力インストールの手間をかけずに利用できるように設計されていますが、ユーザー自身で環境を整えることで、全てのreStructuedTextとSphinxの機能を使用することができます。 (一部、Windowsのみの提供になります)

Windows

Mac/ Linux
reStructuredText Extention
for VSCode
(このエクステンション)
必要
VSCodeからインストール
必要
VSCodeからインストール
Python/ Sphinx
エクステンションに組み込み済。
必要最低限の機能の使用であれば、
インストールは必要ありません。
* Sphinxのカスタマイズを行う場合は、
ご自身で環境を整えることを推奨します。
必要
TeX
pdfに書き出すときは必要
[Taskからインストーラーの起動が可能]
pdfに書き出すときは必要
[ご自身でインストールしてください]

エクステンション

[全てのOS共通]

  • Visual Studio CodeのExtensionsから、”reStructuredText“と検索し、インストールします。

Python/ Sphinx

既にPythonやSphinxをインストールされている方は、ご自身の環境をご使用ください。
Windowsの方は、エクステンションに組み込まれているものがありますので、必要最低限の機能の使用であれば、インストールは必要ありません。
Sphinxなどの環境のカスタマイズを行う場合は、ご自身で環境を整えることを推奨します。
[Windows (エクステンションの組み込みを使う場合)]

  1. VSCodeのメニューの [Terminal> Run Task] を選択する

  2. 画面上部に出てくるダイアログから、[sphinx] を選択する

  3. [Quick Start] や [Build: html [Built-in build]] などの項目が表示されるので、実行したいタスクを選択する

[Mac/ Linux/ Windows(自身で環境を整える方)]

  • Python をインストール

  • Sphinxをpipインストール

  • 必要に応じて、sphinx-rtd-theme などのテーマをインストール

Note

エクステンションのタスクを使ってビルドなどを行う場合、VSCodeで開いているフォルダをワークディレクト リとして、 make html などのコマンドが実行されます。 この時、仮想環境を指定する機能は無いため、グローバル環境を使用することになります。 (PATHを仮想環境のディレクトリに通しておけば、使える可能性はあります)

TeX

pdfファイルを書き出す際に必要です。
既にインストールされている方は、ご自身の環境を使用していただいて構いません。
Windowsの方は、TaskメニューからTeXのインストーラーを起動することができます。
起動するインストーラーのバージョンは TeX Live 2021 になります。

Warning

TeX Liveのインストールは1-2時間程度かかるので、時間の余裕のある時に行ってください

[Windows]

  1. VSCodeのメニューの [Terminal> Run Task] を選択する

  2. 画面上部に出てくるダイアログから、[sphinx> Launch TeX Installer] を選択する

  3. インストーラーが起動するので、インストーラーの指示に従ってインストールを行う

  • もし、TeXの別のバージョンをインストールしたい場合は、ご自身でインストーラーをダウンロードし、インストールを行ってください。

    • TeX Liveのインストーラーは、 こちら からダウンロードできます。

[Mac/ Linux]

  • ご自身でインストールしてください。

  • インターネットで、[TeX install]と検索すると情報が出てきます。

  • TeX Liveのインストーラーは、 こちら からダウンロードできます。