ReadTheDocs によるドキュメントビルド環境の構築

ReadTheDocs テーマを使って公開されているドキュメントを日本語に翻訳する際の環境構築。ここでは peewee-validates をサンプルとして使用しています。

事前に GitHub 上で peewee-validates を fork しています。今後ここにあるドキュメントを日本語のものに差し替えていきます。

PS> git clone git@github.com:hotta/peewee-validates.git
PS> cd peewee-validates
PS> python -m venv env
PS> ./env/Scripts/Activate.ps1
PS> python -m pip install --upgrade pip
PS> pip install sphinx-rtd-theme
PS> pip install peewee python-dateutil     # ここはパッケージの内容により異なる
PS> make docs

最後の行は make html の場合もあります。make [Enter] とすると、使用法が表示されます。

これで docs/_build 内に公開対象の HTML ファイルと画像等が展開されます。

ちなみに、翻訳中のネタ(日本語マニュアル)は以下に置いています。

タイトルとURLをコピーしました