sphinx-revealjs

はじめに エクスペクト・パトローナム！1 nikkieです。 久しぶりのSphinxネタです。 Sphinxを使ってチュートリアルや発表資料を作る中で、Pythonの対話モードの実行例を書くことがあります。 内容を調整しているうちに、気づかず実行例を壊してしまうことがあったのですが、Python標準ライブラリのdoctestでテストできることを知ってから、実行例を壊してしまう不安から解放されました！ 目次 はじめに 目次 この記事で扱うツール Sphinxと実行例 doctest 伝えたいこと nikkieのSphinx × doctest使用例 通常ユースケース reSTのコメントを使って前…

はじめに うるせェ！！！ 行こう！！！！、nikkieです。 Sphinxに関する小ネタです。 ビルドしたHTMLに取り消し線1を引く方法を共有します。 目次 はじめに 目次 結論：Sphinxで出力するHTMLに取り消し線を引く方法2つ 1. ライブラリ sphinxnotes-strike 2. Sphinxで出力するHTMLに取り消し線を引けるように設定追加する 2がこんなに簡単な秘密はdocutilsに 2の使用例（sphinx-revealjs） 終わりに 結論：Sphinxで出力するHTMLに取り消し線を引く方法2つ ライブラリ sphinxnotes-strike を使う 少しの…

はじめに 聞いて聞いて！ nikkieです。 先日以下のように書きました。 sphinx-revealjsいいと思うので、皆さんに使ってほしく、筆を進めねば・・ https://nikkie-ftnext.hatenablog.com/entry/yapc-japan-online-2022-awesome-talks#fn:5 こちらを実現させていきます。 まずは一番単純なトピックから。 sphinx-revealjsで作ったスライドをGitHub Pagesで公開する方法を共有します！ ちなみに私の登壇資料は、2021年からsphinx-revealjs × GitHub Pagesという…

概要 Sphinxを使ったドキュメント作成を勉強するためにまとめたもの。 概念の理解 Sphinx（スフィンクス） python製のプレゼンテーションビルダー（知的で美しいドキュメントを簡単に作れるようにするツール）。 Georg Brandlによって開発され、BSDライセンスのもとで公開されている。 SphinxはreStructuredTextという記法を使用して、reSTファイル（拡張子.rst）を作成する。 特徴 出力形式 HTML (WIndowsのHTMLヘルプを含む) LaTeX(印刷可能なPDFバージョン) ePub（Electronic PUBlicationの略称、open…

はじめに 恋アスが現実に！胸熱... nikkieです。 登壇資料作成にはsphinx-revealjsを愛用して静的サイトとしてホストしています1。 このたびブレイクスルーが起きました！ コードブロックをワンクリックでコピーできるボタンを設置できたのです🙌 目次 はじめに 目次 結論 初手、sphinx-copybutton！ Reveal.js CopyCode sphinx-revealjsの機構を利用する 終わりに 結論 Reveal.jsのプラグインを使って実現しました！ https://ftnext.github.io/2024-slides/pyconshizu/logging-…

はじめに がんばったのに…な…1、nikkieです😭 Sphinxのロール、これは本当に多様なんです！ コード片もコマンドもファイルパスも全部2連バッククォートでマークアップしていましたが、より適切なロールを使ってスタイルを整えられるのです。 目次 はじめに 目次 Sphinxのロール 2連バッククォートによるマークアップ ピンポイントで使えるロールを紹介！ :command: :file: :guilabel: :kbd: こんなロールまで！使っていきたいロール :code: :abbr: :menuselection: :program: :regexp: :samp: :pep: :rf…

はじめに 「みんな、ウタだよ！」、nikkieです。 先日、愛用しているsphinx.ext.githubpagesを紹介しました。 今回はsphinx-revealjsとsphinx.ext.githubpagesの組合せについて紹介します。 目次 はじめに 目次 本記事の立ち位置 結論：sphinx.ext.githubpagesも使ったsphinx-revealjs製スライドのデプロイ 仕組み：sphinx.ext.githubpagesはなぜsphinx-revealjsでも動くのか？ sphinx.ext.githubpagesの実装 Sphinxのビルダー sphinx-revea…

はじめに PyCon mini 東海 2024、1日ありがとうございました！ nikkieです。 カンファレンスのまとめは別にして、発表準備の中で理解が深まったGitHub Actionsについてです。 GITHUB_TOKENのpermissionsを設定できることをようやく認識しました。 目次 はじめに 目次 GitHub Actionsでリポジトリにコミットを作ろうとするとエラー これまでの解決法：GITHUB_TOKENのデフォルトの権限をread/writeにする 今回知った方法：GitHub Actionsの定義のYAMLファイルでpermissionsを指定する 終わりに Git…

はじめに エンジニアニメ、楽しい時間をありがとうございました！ nikkieです。 9月のふりかえり記事です。 8月はこちら 目次 はじめに 目次 1日1エントリ継続中 技術まわり inline script metadata (PyCon JP 2024) sphinx-revealjs-copycode サブカルまわり ミリオンライブ！ アニメ 終わりに 1日1エントリ継続中 680日を超えました。 読んでいただきありがとうございます！ 技術まわり inline script metadata (PyCon JP 2024) 親の顔を見るよりも多く、仮想環境を用意してPythonスクリプト…

Today I learned。Sphinx拡張開発の中で知ったことです。 目次 目次 Sphinx拡張からロギング 太字のログ出力の実装 ビルダー bold()の実装 終わりに P.S. sphinx-revealjsのロギング Sphinx拡張からロギング 自作拡張の中でロギングしてみようとなり1、sphinx.util.loggingを触りました。 getLogger()してロガーインスタンスを得て、重要度ごとのメソッドにメッセージを渡します（標準モジュールloggingと似ていますね2） logger = logging.getLogger(__name__) logger.info(…

Today I Learnedです。 Sphinx拡張1開発をしていて、ユーザがconf.py中の変数で設定できるようにしたいと思いました。 Sphinxアプリケーションのadd_config_value()メソッドで定義 Builderのconfig属性でアクセス SphinxアプリケーションやTranslatorはBuilderを持つ 目次 目次 設定できるSphinx拡張を観察：sphinx-revealjs Sphinxの設定値（現時点の理解） 設定値の宣言 設定値へのアクセス 設定できるSphinx拡張を観察：sphinx-revealjs やり方をパクるために、お世話になっている2…

リリース報告エントリです。 sphinxcontrib-extdevhelper-kasaneが爆誕しました！ 目次 目次 sphinxcontrib-extdevhelper-kasane（現在 0.2.0） kasaneに至るまで kasaneが提供するSphinx拡張開発体験 終わりに P.S. 機を同じくしてsphinx-revealjsのattakeiさんも sphinxcontrib-extdevhelper-kasane（現在 0.2.0） sphinx-new-tab-link 0.3.0の「動的にクラスを生成して、Translatorに指定する」実装をkasaneとして切り出…

はじめに 一方通行＜アクセラレータ＞！ nikkieです。 ドキュメンテーションツールSphinxには、ひな形となるディレクトリ構造を作ってくれるsphinx-quickstartコマンドがあり、とても便利です。 私はこれを対話的に使わないという使い方をしています。 目次 はじめに 目次 対話的に使えるsphinx-quickstartコマンド 行き着いたアプローチ：必要な引数を全部渡すことで、対話をスキップする 今回知った、対話スキップの-qオプション 今後はこんな感じのコマンドを使っていこう 終わりに 対話的に使えるsphinx-quickstartコマンド 『Sphinxをはじめよう』の…