Sphinx

はじめに 七尾百合子さん、お誕生日 44日目 おめでとうございます！ nikkieです。 毎週水曜のリリース報告エントリです1。 目次 はじめに 目次 sphinx-revealjs-copycode v0.4.0 開発裏話 終わりに sphinx-revealjs-copycode v0.4.0 https://pypi.org/project/sphinx-revealjs-copycode/0.4.0/ reveal.js-copycodeのタグを指定する設定値revealjs_copycode_tagを追加しました！ # conf.py revealjs_copycode_tag = …

はじめに 七尾百合子さん、お誕生日 6日目 おめでとうございます！ nikkieです。 発表資料はSphinx（sphinx-revealjs）で作っている私ですが、リリースビルドで想定外のwarningがあったら1そこで止められると気づきました。 目次 はじめに 目次 できたもの：発表資料をビルドしてリリースするパイプラインを落とす sphinx-buildの--fail-on-warningと--exception-on-warning 脱線：--exception-on-warningはなぜ登場した？ 終わりに できたもの：発表資料をビルドしてリリースするパイプラインを落とす 発表資料は…

aptpod Advent Calendar 2024 の12月9日の記事です。 本日は、テクニカルライターの篠崎が担当します。 当社では今年、ドキュメントサイトをリニューアルし、複数のプロダクトのドキュメントを1つのウェブサイトに統合しました。 これにより、読み手は全体を俯瞰しながら各製品の詳細に読み進めることができるようになりました。 また、私のような制作側にとっては、ページ間のリンクを張りやすくなりました。内容の重複も減らすことができ、更新作業もしやすくなりました。 統合されたドキュメントサイト 製品ドキュメントの作成にはSphinxを使っています。これまでプロダクトごとに別々だったSp…

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

Python のソースから仕様書を生成する方法を紹介します。 仕様書は、クラスごとに分けたウェブページとして生成します。 生成には、Sphinx を使用します。 Sphinx の拡張機能 autodoc、sphinx-immaterial を使用して簡単に実現します。

概要 Sphinx、GitHub Actionsを使用してGitHub Pagesにドキュメントをデプロイするまでをやってみる。 内容 （参考）Sphinx公式 https://www.sphinx-doc.org/ja/master/ リポジトリ作成して、GitHub Pagesの「Source」を「GitHub Actions」に変更。 リポジトリにフォルダやファイルを作成していく。 今回は以下のようなフォルダ構成とした。 .github/workflows/shinx.ymlにGitHub Actionsで実行する内容を記載 python環境にsphinxやsphinxの拡張機能をインス…

目次 目次 attakeiさんによるsphinx-revealjs sphinx-revealjs with sphinx-new-tab-link 必要な設定 reST原稿の例 終わりに P.S. コマンドアップデート版 attakeiさんによるsphinx-revealjs sphinx-revealjsは、SphinxでReveal.js製スライドを生成できるライブラリです。 生みの親のattakeiさんによる記事があります。 私はsphinx-revealjsを愛用しています。 月一ペースで登壇しているので、ひょっとすると日本一（まさか世界一！？）sphinx-revealjsを使って…