目次
前準備
必要な環境をインストールします。
Visual Studio Code
インストールしてなければこちらからインストールしてください。
Python
Python3.9以降がインストールされていて、pipが実行できる必要があります。
PowerShellなどを起動して、python --versionを実行してバージョンを確認してください。インストールされていなかったり、古いバージョンだったらこちらなどを参考にインストールしてください。インストールの際には環境変数を設定するオプションを付けるとよいです。
PowerShellやコマンドから以下を実行して、バージョンが確認できればOKです。
python --version
pip --version
pipでエラーが出た場合のことは後述します。
次に以下のコマンドでSphinxのインストール、兼、アップデートをします。
pip install -U sphinx
以上で準備完了です。
翻訳用のSphinxプロジェクトを作成する
reStructuredTextのプレビューをするには、Sphinxのプロジェクト設定が必要です。以下の手順で作成します。
- PowerShellなどで作業用フォルダーを作りたい場所へ移動します
- 以下のコマンドを実行します。
rst-viewの場所は任意で変更してください
sphinx-quickstart rst-view
- 選択肢が表示されるので次のように答えます
- Separate source and build directoriesは任意で。シンプルにするならそのままEnterを押します
- Projet name:には、
translate-docsなどのプロジェクト名を入力します - Author name:には、著作者名を入力します。公開しないなら適当でいいです
- Project release []:は空欄のままEnter
- Project languageは、日本語なら
jaを入力します
以上で作成完了です。
VSCodeで最初の設定
はじめて開くときの設定をします。
- VSCodeを起動します
Pythonやpipでエラーが出たら
普段、Pythonを使っておらずメンテ不足でエラーが出てました。以下、実施したことです。
Pythonの再インストール
古いPythonをアンインストールして、Python3.11.8にしました
環境変数の整理
pip --versionをしてもエラーで実行できませんでした。原因は古いPythonのパスが環境変数に残っていたことでした。
- システムのプロパティを開いて、詳細設定タブの環境変数をクリック
- ユーザー環境変数、システム環境変数の双方のPathを確認して、古いPython関連の設定を全て削除
- PowerShellやVSCodeを閉じて、起動し直す
以上でエラーがなくなりました。この部分で大幅にハマっていました。Pythonのバージョンが3.9移行でpipが実行できればすんなり動くのではないかと思います。
https://www.python.jp/install/windows/install.html
VSCodeへのインストールs
必要なエクステンションは
F1キーでコマンドパレットを表示して、Python: Interpreterで選択する。