nikkie-ftnextの日記

イベントレポートや読書メモを発信

Sphinx

Sphinxで作るHTMLのドキュメントに、ボタンやカードやグリッドを! sphinx-designの紹介

はじめに いいわいいわ! nikkieです。 Python Boot Camp(a.k.a. pycamp)のライディングページをSphinxで作って得た知見をアウトプットするシリーズ1です。 ランディングページをぜひご覧になっていただきたいのですが、ボタンやカードの並びがあるんです…

sphinx.ext.autodocでdocstringを元に作ったHTMLの中の外部リンクも、sphinx-new-tab-link を使ってブラウザの新しいタブで開けることを確認しました

はじめに 聞いて聞いて! nikkieです。 ドキュメント変換ツールSphinxのautodoc拡張を使うと、Pythonファイルからドキュメント(HTMLやPDFなどなど)を作れます。 HTMLでドキュメントを作るときに、このautodoc拡張と、私が先日リリースしたライブラリsphinx…

pycampランディングページの参加人数表は誰でも簡単に更新できるよう、Sphinx拡張を自作して実現しました

はじめに 秘密はね、最後に明かされるんだよ、nikkieです。 Python Boot Camp1(a.k.a pycamp)のライディングページを今年Sphinxで作りました!2 この実装の一部「過去の開催回で集まった人数」の表について、実装の秘密を明かしちゃいます! 目次 はじめに…

reStructuredTextとリンクを作るマークアップ(全部一緒だと思っていたのですが、細かい意味の違いがあった…だと…)

はじめに ずっとずっと、一緒だと思っていた。1 nikkieです。 reStructuredText(reST)にはいろんなマークアップがありますよね。 リンクを作りたいときは `Link text <https://domain.invalid/>`_ と書いてきた2のですが、これが何をしているか何も分かっていなかったことをこのたび</https://domain.invalid/>…

sphinx-revealjsで作ったスライドをGitHub Pagesで公開するときにもsphinx.ext.githubpagesは味方してくれます!

はじめに 「みんな、ウタだよ!」、nikkieです。 先日、愛用しているsphinx.ext.githubpagesを紹介しました。 今回はsphinx-revealjsとsphinx.ext.githubpagesの組合せについて紹介します。 目次 はじめに 目次 本記事の立ち位置 結論:sphinx.ext.githubpag…

SphinxでビルドしたHTMLをGitHub Pagesで公開するときの頼れる味方、sphinx.ext.githubpagesを知っていますか?

はじめに 「みんな、ウタだよ!」、nikkieです。 今回はSphinxでビルドしたHTMLをGitHub Pagesで公開するときのtipsをアウトプットします。 sphinx.ext.githubpagesってご存知でしたか? 目次 はじめに 目次 SphinxとGitHub Pagesを一緒に使うときの落とし穴…

SphinxでビルドしたHTMLの中の外部リンクを、ブラウザの新しいタブで開くように設定する拡張 sphinx-new-tab-link を公開しました!🎉

はじめに 聞いて聞いて! nikkieです。 このたびPyPIにちょっとしたSphinx拡張をリリースしました! この記事ではそのライブラリについて紹介していきます。 目次 はじめに 目次 前提:SphinxでHTMLをビルドする たたーん♪ その名もsphinx-new-tab-link! ブ…

sphinx-revealjsで作ったスライドをGitHub Pagesで公開する

はじめに 聞いて聞いて! nikkieです。 先日以下のように書きました。 sphinx-revealjsいいと思うので、皆さんに使ってほしく、筆を進めねば・・ https://nikkie-ftnext.hatenablog.com/entry/yapc-japan-online-2022-awesome-talks#fn:5 こちらを実現させて…

Sphinxでクロスリファレンスを機能させるためには、includeするファイルをrst以外の拡張子にすべきと身をもって学びました

はじめに 頑張れば、何かがあるって、信じてる。nikkieです。 技術同人誌執筆以来使っているドキュメンテーションツールSphinxで、includeするファイルはrst以外の拡張子にするべきということを知りました。 Tips: you should use other extensions for incl…