インストールと基本的な流れ

pip install sphinx sphinx-rtd-theme myst-parser pydata-sphinx-theme

プロジェクト作成

1. ディレクトリ作成

   mkdir jsap-seminar2025
   chdir jsap-seminar2025
   

2. 初期ファイル作成

   sphinx-quickstart
   

HTMLをビルド

1. 必要があれば

   make clean
   

2. 実行

   make.bat html
   

公開

1. build\html 内のファイルを Web サーバにコピーする

   Windows の場合は robocopy、Linux の場合は rsync などを使うと便利。

   robocopy .\build\html\ \\サーバーパス\docs /MIR /Z /W:5 /R:3
   

   リリースバッチファイルの例

   @echo off
   setlocal
   
   :: 1. SphinxでHTMLをビルド
   call make.bat html
   
   :: 2. サーバーの共有フォルダへ同期
   :: 送信元: .\build\html
   :: 送信先: \\ServerName\SharePath\xrd_docs
   set SRC=.\build\html
   set DST=\\ServerName\SharePath\xrd_docs
   
   echo 同期を開始します...
   robocopy "%SRC%" "%DST%" /MIR /Z /W:5 /R:3 /FFT /XJD /NP
   
   echo 同期が完了しました。
   pause
   

2. html/index.html にアクセスする