年末年始の休みは、以前からやろうと思っていたMicroPythonの拡張・移植ガイドの執筆に取り掛かりました。
ドキュメントの形式は、MicroPythonにならってSphinxを使ってみることにしました。
SphinxはPythonで作られたマークアップ言語で、HTMLやePub、PDFなど様々な形式で出力することができます。PDF出力はLaTeXを使用しています。まだ公開方法が確定していないので、いろいろな方法が選べるのは有難いです。
参考にしたのは以下のサイトです。
Sphinxをはじめよう — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
また、下書きはモバイル環境からでも編集できるように、Scrapboxを使っています。
ある程度まとまったら、図やサンプルコードを含めた版を家のPCで作成し、Githubのプライベートリポジトリで管理しています。
MicroPythonの移植に関するドキュメントは、公式ドキュメントが無いので、あったら便利だろうとは以前から思っていました。
しかし、ブログ記事として一度にポストするには複雑すぎる内容で、かといって複数回に分けてポストするには、相互依存する内容が多いので分割の仕方が悩ましく、結局ブログ記事ではなく一つの文書にするのが良いだろうという結論になりました。
とはいえ、そういったものを書くのに必要な、全体構成を考えるためのまとまった時間はなかなか捻出できません。この年末年始の休みは、年始のイベントや年賀状を差し引いても3～4日の時間が取れそうだったので、チャンスでした。
まだ全体構成ができて、部分的に書き始めた段階ですが、多分B5版で30～50ページくらいの分量になると思います。
公開方法は決まっていませんが、以前から興味のあったBOOTHやKindleなどの電子出版にしてみようかなと思っています。
コメント