免責
本記事の内容は未検証です。検証前に「次はこうしてみよう」「たぶんこれで行けるんじゃないか？」と考えているだけの内容です。
はじめに
Sphinx に適した IDE をずっと探していたのですが、あまり「ズバリ」というものは見つかりませんでした。
要は「プロジェクト」としてまとめることができて「ビルド」ができれば良いので、なんでも良いのですが。
VSCode でビルドできるようにしてみる
Visual Studio Code（以下 VSCode）ではビルドタスクが設定できます。それを利用できないかやってみます。
-
どこか
sphinx-quickstartでプロジェクトを作るディレクトリを作成します。 -
そのフォルダを VSCode で開きます。
-
メニュー「ターミナル」 > 「ビルドタスクの実行...」を選択します。
そうすると、最初は「実行するビルド タスクがありません。ビルド タスクを構成する...」という選択肢が出るので、それを選択します。
空の状態から構成をしたいので次に「テンプレートから tasks.json を生成」を選択します。
タスクテンプレートは、一番下の「Others 任意の外部コマンドを実行する例」を選択します。
そうすると、空だったフォルダに .vscode というフォルダと、その中に tasks.json というファイルができて、エディタでそれが開いた状態になります。
-
tasks.jsonを以下のように編集します。⭐️のところがポイントです。
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "Sphinx Build", // ⭐️タスクの名前
"type": "shell",
"command": "${workspaceFolder}/make", // ⭐️make コマンドを実行
"args": [
"html", // ⭐️make コマンドの引数
],
"problemMatcher": [], // ⭐️ビルド実行時に、このタスクをデフォルト実行する設定
"group": {
"kind": "build",
"isDefault": true // ⭐️デフォルト実行するタスクであることを示す
}
}
]
}
- これで、メニュー「ターミナル」 > 「ビルドタスクの実行...」を選択をすると
make htmlが実行されるようになります。ショートカット（キーボードショートカット）は「Shift + ⌘ + B」（Windows は「Shift + Ctrl + B」）です。
Windows 用
"command": のところは、以下のようにしなければいけないかもしれないです。
"command": "${workspaceFolder}\\make.bat",
プロジェクトファイルを作ってみる
.xcodeproj とか .csproj とか、ダブルクリックすると、そのプロジェクトが開くじゃないですか。あんな感じにしたい。そうすれば Spotlight でも開けるようになる し。
VSCode では「ワークスペース」という単位で、編集対象のファイル群を保存しておく機能があります。メニューの「ファイル」> 「名前をつけてワークスペースを保存...」で、適切な名前をつけてプロジェクトフォルダ内に保存します。
残念ながら .sphinxproj などという拡張子にはなりませんが、まあ必要十分でしょう。
その後
その後（前でもいいと思いますが）sphinx-quickstart すれば Sphinx ドキュメントの開発に進めると思います。
その他
Sphinx のための便利な情報・ツールは以下などを参照。
- VSCodeとDockerで快適なSphinx(reStructuredText, rst)編集環境を作る - Qiita
- reStructuredText Extension for Visual Studio Code — restructuredtext 1.0 documentation
- Excel 表を reStructuredText の表に変換するアドイン - Qiita
- Markdown — Sphinx documentation
- Sphinxを便利にして、みんなに使ってもらいたい - Qiita
- sphinx でドキュメント作成からWeb公開までをやってみた - Qiita
- Sphinx に PlantUML のコードを埋め込む - へっぽこプログラマーの備忘録
- SphinxでPlantUMLやblockdiagを書く用のDocker - Qiita
ひょっとして VBScript のプロジェクトも、これで行けるんじゃないかな。