Sphinxの環境をpython3対応した話 - uokadaの見逃し三振は嫌いです

昨日、github-pagesの生成に使っているSpinx環境を python3.6に移行した。

使っているライブラリを最新のバージョンにあげるだけで問題なかったが1つだけpython3に対応していないものがあってそれがsphinxtogithub。

このライブラリはsphinxで生成したページのcssなどのリンクを_staticからstaticに変えるというライブラリです。

_staticだとgithub-pageでcssにアクセスさせてくれずstaticに変える必要がありこのライブラリがないというのは結構致命的にな問題であった。

対応策を探すためにライブラリのgithub リポジトリをみていたところpython3対応のPRがすでに出されていた。

このPRは3年ほど放置されていてマージが期待出来なかったのでPR作者のリポジトリからライブラリを取るようにしてpython3対応を完了させた。

pipで次のようにすればPRもとからライブラリをインストール出来ます。

% pip3.6 install -e "git+git://github.com/proycon/sphinx-to-github.git#egg=sphinx-to-github"

requirements.txtに書くときは下のようにするとインストール出来ます。自分は上のpipコマンドでインストールしてpip freezeした結果をrequirements.txtに記述しているのでコミットのハッシュを含んだ値をセットしています。

# sphinxtogithub==1.1.0
-e git://github.com/proycon/sphinx-to-github.git@9b61be70ccfbec99724544c3e94ed1c43fb5295c#egg=sphinxtogithub

こんな感じで1時間ほどでpython3移行を完了することが出来ました。 python3移行を数年放置してたんですが思ったよりも簡単だったのでみなさんもちょっとした空き時間にやってみると良いのではないでしょうか。