sphinxjp.themes.dotted 0.1.1 リリースしました。

log python sphinx document

序

相変わらず、ゆるいペースでもぞもぞと活動しています。どうも、Python界の流浪人です。朝夕の冷え込みが少しずつ秋の深まりを感じさせる季節になってきましたね。風邪などひいていませんでしょうか?

sphinxjp.themes.dotted 0.1.1 リリース

sphinxjp.themes.dotted · PyPI

さて。タイトルの通りなんですが、先日リリースした sphinxjp.themes.dotted の更新を行いました。内容はPyPIのヒストリに記載しているとおり、

  • サイドバーの表示/非表示の切り替え
  • サイドバー表示位置(左/右)の切り替え


です。

一つ目の方は enablesidebar 、二つ目の方は rightsidebar というオプション名でTrue/Falseを引数に取ります。conf.pyの中のhtml_theme_optionsに、以下のように値を渡して設定します。

html_theme_options = {'slidetoc': False,
                      'enablesidebar': True,
                      'rightsidebar': False,}

当初はサイドバー無しのデザインで通すつもりで居たのですが、Twitter上で「サイドバーは必須だ」といったやり取りを目にして、やはり「在ってもいいのかも」と思い直してサイドバーを使えるようにしてみました。とはいえ、単純に追加しただけではbizstyleと大差が無いので、今回は「サイドバーの表示/非表示を切り替えできるとかいいかも」と考えてトライしてみました。

SphinxのHTMLレイアウトは、テンプレートエンジンにjinja2を使っているので基本的なルールが分かれば結構柔軟にいじることが出来ます。CSSの方も「条件分岐を使って不要な定義を書き出さない」という記述ができるので、動的にスタイルの定義を切り替える事も出来ますしなかなかどうして便利です。

結

今回は自分の中からではなく外部からきっかけを頂くことで手を動かしたのですが、こういう風に「こうして欲しい！」とか「ああだったらイイのに！」という働きかけは何かを作る側の背中を押す効果があるのだな、としみじみ思いました。

デザイナーではないので見た目のセンス的にはアレですが、使って頂ければ幸いです。