ビルド

ビルド機能を使うと、これまでコマンドプロントを立ち上げて行っていたビルド処理をVSCodeから行うことができます。

---

タスクの種類

• 各タスクは、 [User env build] と [Built-in build] が用意されています。

• [Built-in build] は、現状Windowsのみの対応です。

Task	説明
epub	epubへ変換
html	HTMLへ変換
latex	latexへ変換
latex pdf	PDFへ変換
Make Clean	buildフォルダのリセット(フォルダ内コンテンツの削除))

---

使い方

1. make.bat ファイルが保存されているディレクトリを、ワークスペースフォルダとして開きます( File> Open Folder... )

   

2. Terminal> Run Task... を選択します

   

3. sphinx という項目を選択すると、ビルドできる項目が表示されます

   • 環境によって、表示されない項目もあります。

   
   

3. Terminalが起動し、ビルドが開始されます

   

4. 最後に Enter などのボタンを押し、Terminalを閉じてください

---

[User env build]

ユーザーのマシンの環境を利用してビルドを行います。 ご自身で環境を整えている方は、こちらのオプションを利用することを推奨します。

[Built-in build] の環境で提供しているもの以上にカスタマイズを行いたい場合は、ご自身で環境を整え、こちらのオプションで実行する必要があります。

このオプションの項目を選択すると、PowerShellで ./make XXX のコマンドが実行されます。

• ./make XXX の XXX の部分には、 html epub latex latexpdf clean のいずれかが入ります

• カレントディレクトリ(ワークディレクトリ)は、VSCodeのワークスペースフォルダになります

各種環境パスが適切に通っていることが必要です。 エラーが起こった場合は、Terminalのメッセージを確認してください。

---

[Built-in build]

(現在、Windowsのみの提供)

エクステンションに同梱されている、 sphinxhelper.exe を実行させることでビルドを行うオプションです。 ユーザーが環境を整えられなくても、必要最低限のビルドが行えるようになっています。

ビルドを行うツールの環境は次の通りです。

ツール名	バージョン
Python	3.9.6
Sphinx	4.0.2
sphinx-rtd-theme	0.5.2

pdfファイルへ変換を行いたい場合は、別途 TeX をインストール必要があります。

(もし、 [Built-in build] で導入してほしいツールがあれば、 Issues に投稿してください)

Note

セキュリティソフトによっては、 sphinxhelper.exe の実行に制限が加えられる可能性がありますので、このファイルの実行を許可してください。

尚、このexeファイルの元になっているファイル/プログラムは、 GitHub で公開されています。

---

Note

もし、トラブルが解決できない場合は、 Issues に報告してください。 バグなどの報告はこのページからのみ受け付けています。