Sphinx

最初のOnStep Sphinxを製作したのは1年半前の2025年1月でした。 2台目の中古Sphinxを入手したのが1年前。しかし、スマートな形に仕上げようと考えすぎて、その後の作業が進んでいません。自作の基板では大きすぎで悩んでいましたが、国内で基板が販売されたのが半年前の2026年1月。1万円弱だったので早速入手。 これではいつまで経っても完成しないと思い決心。BLOGで製作日記を書きながら自分自身を鼓舞しながら1か月で完成したいと思っています。 この基板はwifiは日本の技適マークもついているし、ドライバーは2209で電流の設定も可能だし、ファームウエアがワイヤレスで変更可能なのでコン…

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

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の拡張機能をインス…