Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Sphinx-themes.org in Sphinx-con 2018

shirou
November 28, 2018

Sphinx-themes.org in Sphinx-con 2018

This is a LT slide of "Sphinx-themes.org" which is held in sphinx-con 2018.

shirou

November 28, 2018
Tweet

More Decks by shirou

Other Decks in Technology

Transcript

  1. sphinx-themes.org
    わかやま しろう

    View Slide

  2. お前だれよ
    わかやま しろう
    「sphinxをはじめよう」の著者の一人
    https://github.com/shirou
    https://twitter.com/r_rudi
    AlpacaJapanという金融と機械学習の会社で働いています

    View Slide

  3. テーマ
    Sphinxの魅力の一つは豊富なテーマです。
    標準以外に多種多様なテーマが公開されており、簡単に使えます。
    % pip install sphinxjp.themes.gopher
    あとは conf.py の html_theme を編集するだけ
    html_theme = 'gopher'

    View Slide

  4. 問題点
    あまりにも多くのテーマが公開されている。
    説明がないものも多数。
    古くてインストールに苦労するものも。

    View Slide

  5. https://sphinx-themes.org (https://sphinx-themes.org)
    というのを作りました。
    pypi上にあがっているテーマを一覧表示
    chromium-headlessでスクリーンショットを取得
    サンプルページを見れる
    conf.pyのサンプルも見れる
    現在109ぐらいのテーマを一覧できるようにしてあります

    View Slide

  6. どうやって作ってるの?
    表示
    preactを使って軽量に表示
    jsonファイルとしてデータがあるので読み込んで表示
    sakuraのサーバーでホスト
    サンプル作成
    pip search sphinx でテーマっぽいものを調べる
    ひたすら手動でpypiインストール。
    sphinx用のdockerコンテナを用意し、コマンドも用意してあるので、一個にかかる時間は1
    分ぐらい
    インストールに手間取るものだと時間がかかる
    ということで、更新は「手動」です。現状半年に一回ぐらい、気が向いた時にやるだけです。

    View Slide

  7. 苦労したところ
    一つの拡張に複数のテーマが含まれていることがたまにある。
    古いテーマはconf.pyの書き方が統一されてないのでインストールできないことがある
    そういうのは諦めています
    思いついてドメインを取ってから5年たってました。誰も作ってくれなかったねん…
    時間:2012-12-12 23:45
    ドメイン名:sphinx-themes.org

    View Slide

  8. View Slide