Sphinx

はじめに Sphinx、全然理解せずに使ってたな… nikkieです。 ドキュメント変換ツールSphinx、私は執筆や発表資料作成でもヘビーユースしています。 シンタックスハイライトしたコードの表示はcode-blockディレクティブ1やliteralincludeディレクティブを使ってきたのですが、このたびあと2つあることを知りました。 このエントリの流れとしては知った順に見ていきますが、「終わりに」に4つをまとめています。 目次 はじめに 目次 前提 動作環境 すでに知っていたcode-blockディレクティブ すでに知っていたliteralincludeディレクティブ 存在を初めて知った…

はじめに エクスペクト・パトローナム！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です。 Python Boot Camp1（a.k.a pycamp）のライディングページを今年Sphinxで作りました！2 この実装の一部「過去の開催回で集まった人数」の表について、実装の秘密を明かしちゃいます！ 目次 はじめに 目次 「過去の開催回で集まった人数」の表 案：csv-table × マークアップしたCSV Sphinx拡張を用意して、CSVではマークアップ不要にする csv-tableディレクティブの動きを知るのに役立ったリソース 思わぬ収穫：csv.readerはリストも受け付ける 終わりに 「過去の開催回で集まった人…

技術ドキュメントを作成する際に、よく使われているsphinxを使ってみました。 使い方解説！までできればよかったのですが、 なかなかできることが多く、うまいことまとまりませんでした。 今回は、ある程度使ってみた感想を記載したいと思います。 sphinxとは 採用例（opencv） 使ってみた感想 導入は簡単 文書の作成方法 rstファイルに馴染みが無い 凝ったことをやるための道のりが遠い sphinxとは 技術ドキュメントを作成するのに人気のツールですね。 「プログラマが文書を書きたくなるツール」というのがキャッチフレーズですね。 プログラマというのは、「プログラム動いているのに文書なんて必要…

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

はじめに 頑張れば、何かがあるって、信じてる。nikkieです。 技術同人誌執筆以来使っているドキュメンテーションツールSphinxで、includeするファイルはrst以外の拡張子にするべきということを知りました。 Tips: you should use other extensions for included documents (cf .txt). 目次 はじめに 目次 要するに サンプルドキュメント index.rst section1.rst subsec1.rst subsec2.rst 環境 PDFビルドコマンド 解決策 解決する理由 拡張子を変えたあとの色分け設定（VSCo…

先月は、パッケージのdouble build問題への対処やDMARCがらみのことを調べてまとめたりしたり、 メロンブックスさんで Ultimate Hacking Keyboard 60入門を頒布しはじめたりもした。在庫はあと2冊のはず。 物理本を欲しい方はそちらをどうぞ。 linux-firewire-utilsのレビューに協力をしたりもしている。 08/01 https://docs.confluent.io/platform/current/installation/installing_cp/rhel-centos.html confluent-community-2.13のインストー…

実際のところ ドキュメント生成ライブラリのSphinxが推奨なので sudo apt install \ python3-sphinx \ python3-sphinx-autodoc-typehints \ python3-sphinx-rtd-theme 導入 ROS2の作業ディレクトリがros2_wsで、環境構築が終わっている場合 cd ~/ros2_ws/src git clone https://github.com/ros2/rclpy.git cd .. colcon build --symlink-install有効化……ついでにドキュメントの生成 source install…

はじめに ういっす✌️ nikkieです。 自作したPythonライブラリのリリースのお知らせです。いえーい！🎉 目次 はじめに 目次 HTML製スライドのあるページを、画像で保存したい！ それ hayasaka でできるよ hayasaka開発秘話 終わりに P.S. hayasaka（はやさか）って、誰よ HTML製スライドのあるページを、画像で保存したい！ 私は発表資料の作成にsphinx-revealjsを使っています。 発表資料の実体は、1枚のHTMLです。 この発表資料について、表紙のスライドを画像にしたいというニーズが私にはあります。 発表資料のURLをTwitter（X）でシェ…

Hieroglyph:ヒエログリフ: hiéroglyphique:仏: G17: HiBou[F]owl:G17: https://live.staticflickr.com/5796/20770674203_c100303ee8_b.jpg https://www.um.es/cepoat/egipcio/wp-content/uploads/dictionnaire-egyptiene.pdf https://sun9-78.userapi.com/impg/pl-9Wl6Et0pJWm39vf7wSFkl4tNoTW0OCb0t2w/Fb0tMCMOuXU.jpg?size=604x4…

はじめました！ にっきーの「っきー」はCookiecutterの「っきー」1。nikkieです。 先日Cookiecutterの素振りをしました。 Cookiecutterテンプレートの作り方が分かったので、taskipy用のテンプレートを公開しました！！🎉 目次 はじめました！ 目次 taskipyとは ftnext/cookiecutter-taskipy なぜ作ったか 使い方 今後 終わりに taskipyとは pyenv + venv の呼吸 弐の型2です！ taskipyはPythonを使った開発で使うツール類を簡単にまとめられるライブラリです。 pyproject.tomlに設定を…

- 06. AUGUST * Andy Warhol * 218日目 あと147日 TOKYO_SUNRISE-04:52 SUNSET-18:41 MOON-19.4 DAYS _ Who built the Sphinx? Who broke its nose? 4,500 years later, https://www.nationalgeographic.com/premium/article/great-sphinx-giza-pyramids-pharaoh-ancient-egypt 広島平和記念日，広島原爆忌, 雨水の日, 太陽熱発電の日, ハムの日, ハロースクエアの日, …

はじめに きっとー みんなーがー 幸せーだーよー♪ nikkieです。 久々のタイトルが全て記事です。 📣コミケに行かれる皆さま、『アイの歌声を聴かせて』にちょっとでもご興味ありましたら、ぜひぜひ土曜日（8/12）東6タ24bまでお越しください〜 ※nikkieは売り子ではないので、エンカウントは保証できませぬ🙏 目次 はじめに 目次 『アイの歌声を聴かせて』ファン合同誌 技術者視点で2ページ寄稿させていただきました！ 終わりに P.S. その1 nikkieの関連エントリ P.S. その2 アドベントカレンダーのもっとお祭り騒ぎが今回の合同誌なのかも 『アイの歌声を聴かせて』ファン合同誌 #…

6月28日～29日Grindelwald, Bern , Schweiz：Männlichen 天候に確信を持てないまま、1泊2日で隣国に向かいます。6月28日 日本出国前、旅行の打ち合わせをする中で、候補に上がっていたｽｲｽ。友人の負担を考え、必ず行きたいとは言えない中で、友人が強く計画を進めてくれたのは、自分の顔に出ていたからかも知れません。しかし、計画を立てた週は、これまでと違って天候が不安定。その中でも、可能性のある2日間に賭けて、ｽｲｽはGrindelwaldに向かいました。 出発前、友人が利用したことのあるﾎﾃﾙに問い合わせをしましたが、要領を得ない部分があり、またGrindelw…

Hieroglyph:ヒエログリフ: https://sun9-37.userapi.com/impg/_KOmsZ3P0qMd1i7vFwNBLN60aW1QzKpUoG2dWA/kOOjHOZNrDY.jpg?size=807x647&quality=96&sign=d4c8dbfbcaf28e3bc09feac5b4d5bf04&c_uniq_tag=YfqwmJBbzxWWcl7geRwlK8XCAUdZhjdj650rSj2A_IQ&type=album Ancient Egyptian writing2020 7月 1What is the peculiarity of the i…

例えば MoviePy パッケージには Sphinx によるドキュメントが用意されています。 User Guide — MoviePy 1.0.2 documentation そうすると自分のパッケージにもそのようなドキュメントを用意したくなると思います。なので、MoviePy 同様に Sphinx ツールを利用し、ホスティングサービスに Read the Docs を利用します。参考文献 1. の Sphinx-RTD チュートリアルにしたがいます。そうするとなんやかんやで以下のようなドキュメントができます。 Welcome to cookies_utilities’ documentati…

はじめに 変更しやすいコードが書けないのにソフトウェア開発とか舐めているのですか 天使様1ごめんなさい〜、nikkieです 「かわいい」と技術書が夢の合体を果たした、ちょうぜつ本（『ちょうぜつソフトウェア設計入門』）！🤗 読書会と絡めて読み進めており、今回は第3章「オブジェクト指向」を読みました。 目次 はじめに 目次 前回のちょうぜつ本！ オブジェクト指向、「多態性」と「継承／汎化」の理解度爆上がり 多態性（ポリモーフィズム） 継承／汎化 その他感想 終わりに P.S. 7/21(金) 第3章「オブジェクト指向」のちょうぜつ本_読書py！ 前回のちょうぜつ本！ いわしまんさんの書評エントリが…

Excelファイルから表を作るSphinx拡張について、埋め込み画像に対応しました。 特にオプションなどは必要なく、画像が使用されたExcelファイルを指定すれば、そのまま画像が利用されます。 .. xlsx-table:: :file: path/to/xlsx/embedded-images.xlsx 以下のようにレンダリングされます。 Embedded Images 内部処理 内部処理としては、以下のようにしています。 xlsxファイルを解析して、画像データを抜き出し、ファイルに保存 Ezcelファイル名.xlsx.mediaのフォルダを作成し、保存します 画像アンカーの位置からセル (…