使用背景
プロジェクトでメンバーに情報共有用に「sphinx」が便利そうだので使ってみました。
OSはWindows10を使用
参考記事と公式サイト
PowerShell を起動し、sphinxをInstall
pip install sphinx
Successfully installed と表示されればOK
プロジェクトフォルダを作成し、プロジェクトフォルダに移動する
mkdir test
cd test
プロジェクトの作成
sphinx-quickstart
yを入力して進む
色々聞いてくるので入力する
フォルダ内のファイル構成を確認する
補足情報
make コマンドでhtmlを叩くとエラーが出ました。
原因はWindowsでmakeを使う場合ChocolateyかMinGWやCygwinのインストールが必要らしいです。
以下、ChatGPTのコメント
makeは、主にソフトウェアのビルドプロセスを自動化するために使用されるツールで、UNIX系の
オペレーティングシステムで一般的に利用されますが、Windowsでは標準では提供されていません。
自分はChocolateyをインストールしました。
PowerShellを管理者権限で起動する。
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
インストールが完了したらPowerShellを再起動し、再度管理者権限で起動する。
インストールの確認してmakeコマンドをインストールする。
choco
choco install make
プロジェクトにhtmlを作成する
make html
ビルドが成功したらbuild直下にhtmlフォルダが作成される
htmlフォルダに移動しindex.htmlを確認する
テーマを変更する
conf.pyはsource直下にあります。
デフォルトのテーマは"alabaster"でした。
今回はbizstyleを使用した。
html_theme = 'bizstyle'
ページの作成
デザインが変わらないときはmake htmlを叩く
ページを追加していく
ドキュメント構成に関しては、下記記事がわかりやすかったです。
一先ずはドキュメント作成まで出来ました。
これ以降は記述方法を学びながらドキュメントを追加していきます。