sphinx-revealjsを作ってSphinxCon JP 2018でトークした

2018-12-10(Mon) | Tech

少し時間が経過してしまったけれど、sphinx-revealjsを0.4.0へ更新したので、 ちゃんとブログとして書くことに。

SphinxCon JP 2018

11月の終わりに SphinxCon JP 2018 が開催され、 通常トーク枠として「素材の良さを活かしつつ、reSTをReveal.jsに変換してみる話」というタイトルで発表した。

https://attakei.gitlab.io/slides/talks/sphinxcon-jp-2018

10分枠だったのですが、話をまとめきれずに予定を少々オーバーしてしまった。ちょっと反省。

内容としては、 通常のHTMLビルドでの生成内容をベースに``sphinx-revealjs`` の中身を交えつつ、 「ここが嫌だからこうした」というものがメイン。 Revael.jsのくだりと準備不足が問題な気がするけれど、もう少しReveal.jsに寄せても良かったなとも思える反応だった。

自分の発表も含めて docutils と向き合う系のトークがそこそこ多かった気がする。

その他にも特定のライブラリに閉じたイベントのため、ハイコンテクスト気味な濃い目のトークが聞けて楽しい時間だった。

sphinx-revealjs もう少し深堀り

Sphinxで次のことを実現することを目的とした拡張。

  • なるべく「素のreST」をReveal.jsのプレゼンテーションに変換

  • それぞれのプレゼンテーションで別々のRevealjsテーマにすることが可能

  • この2点を備えることで、複数のプレゼンテーションを「Sphinxドキュメンテーション」として管理できるようにする

自分の中では、「Sphinx + Reveal.js」で代表的なものと思っているのは、 sphinxjp.themes.revealjs で、ちょっとこれとの違いを簡単に整理する。 比較項目を見てもらえれば、「素のreST」を意識して作っているかが現れている。

後発なのと、特に露出の機会もそんなに多くないため、GitHub star数はこちらが圧倒的に少ない。

  • プレゼンテーション生成

    • sphinxjp.themes.revealjs : html ビルド

    • sphinx-revealjs : revealjs ビルド(追加)

  • Reveal.jsセクションの実現

    • sphinxjp.themes.revealjs : ディレクティブによる囲み

    • sphinx-revealjs : reSTのセクションノードをベースにする

  • スピーカーノートの実現

    • sphinxjp.themes.revealjs : ディレクティブによる囲み

    • sphinx-revealjs : reSTのコメントをベースにする

自分はメインPCがLinuxで、 「評価値の高いOffice系ソフトはない」 「大きな発表が少ないためHTMLスライドで十分やっていける」 みたいなことがあるため、 ある程度きちんとドッグフーディングしつつ、欲しい機能を追加しながらメンテしたいと思う。