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…

はじめに チノちゃんをもふもふしたいな〜1、ってココアさんが言ってましたー。nikkieです。 TEX WikiのLaTeX入門から、一部つまんで取り組みました。 もふもふではなく、てふてふの様子をお届けします。 目次 はじめに 目次 nikkieとTeX TEX Wiki LaTeX入門 TEX Wiki 最初の例 TEX Wiki レポートの例 終わりに nikkieとTeX 全然書けません！（お手上げ） この2つの点をつなぐものがSphinx。 Sphinxは原稿（reST）をPDFにビルドすることもできます。 その過程でTeXファイルに変換されていて、reST -> TeX -> PD…

音声でブラウザを操作するプログラムを作成したので作り方を紹介します。 以前に作った音声入力で文章作成するプログラムと ブラウザを操作する RPA のプログラムを使って作成しました。

今日、ゆーがと旅するところは、カイロです～ イスラム建築を代表するモスクが一堂に会する「千の塔の都」。モスクの数は年代を超え300以上とか！ カイロは7世紀後半イスラム帝国が築いた軍営都市に始まり、ナイル川下流の交通の要衝として発展、 イスラム世界の学術・文化・経済の中心都市となり中世には最盛期を迎えました。 世界遺産登録は、1979年。 ナイル川の西側には、ギザの３大ピラミッドとスフィンクス。並ぶ3つのピラミッドは、大きい方から順に、クフ王のピラミッド、その子、カフラー王のピラミッド、また、そのカフラーの子、メンカウラー王のピラミッド。 守護神スフィンクスは、頭部が人間、胴体がライオン。 「…

こんにちは。本記事では、ドキュメント生成ツールのSphinxを使って、技術文書を作成する方法について解説します。Sphinxは、Pythonのドキュメンテーションツールとして開発されたもので、多言語対応やドキュメントの自動生成など、様々な機能を持っています。 Sphinxのインストール Sphinxをインストールするには、以下のコマンドを実行します。 pip install sphinx プロジェクトの初期化 Sphinxを使って技術文書を作成するには、まずプロジェクトを初期化する必要があります。以下のコマンドを実行すると、プロジェクトの初期化が行われます。 sphinx-quickstart…

こんにちは。フリーランスエンジニアの方々がQiitaで実践的な情報を提供するためには、具体的な例を紹介することが重要です。本記事では、フリーランスエンジニアがQiitaで実践的な情報を提供するための具体的な例を、サンプルコードとともに紹介します。 1. ドキュメント生成ツールの使い方 ドキュメント生成ツールの使い方について解説することで、プログラマーにとって便利なツールを紹介することができます。以下に、サンプルコードを用いて、ドキュメント生成ツールの使い方を解説します。 # インストール pip install sphinx # プロジェクトの初期化 sphinx-quickstart # H…

blog.jxck.io で（md2inao→md2indesignの進行は過去にもちょっとかかわりがあってウォッチした） もうすでにそういう製品があったり、知らないだけで全コードがハイライトされた書籍を出してる出版社はあるのかもしれないが、そういう本を少なくとも自分は見てない。 という記載があったのでちょっと書いてみる。 オーム社さん、オライリー・ジャパンさん、インプレスさん、羊土社さん、講談社サイエンティフィク社さんなどの一部の書籍では、コードハイライト付きになっていて、さらにそのうちいくつかは紙版では白黒、電子版ではカラーを使い分けていたりする。 というのも、前職の制作会社時代に私がその…

１から２００ ２００から４００ １から２００ forty (四十):四十、40歳 deep voice (低い声)：低い声、バリトン stentorian (大声で)：大声で、力強い sensible (賢明な)：賢明な、分別のある square body (四角い体)：四角い体、がっしりした体格 encased (覆われた)：覆われた、囲まれた thick boots (厚手のブーツ)：厚手のブーツ、頑丈なブーツ conversation (会話)：会話、対話 telegraphic style (電報式)：電報式、簡潔な形式 weeds (雑草)：雑草、除草 house afire (家が…

$ omae-douyo https://nikkie-ftnext.hatenablog.com/archive/2023/4 この人物は主にプログラミングに関するブログ記事を書いているようです。 最近はPythonのcsvモジュールに取り組んでおり、空行やフィールド数の違うCSVファイルの読み込み方や、CSVファイルからデータクラスのインスタンスを作る方法を模索しているようです。 また、ChatGPTという自然言語処理のモデルにも取り組んでいるようで、日本語テキストをトークンに変換する方法などについても記事を書いています。 その他にも、読書ログや映画鑑賞の記事もあるようで、幅広い趣味や知識…

マークアップ言語とは マークアップ言語とは、PCを用いた文書の作成において、組版(レイアウト)のために図表の位置や章立てなどの情報を文書ファイルに付加するための形式言語(文法、またはマークの規則)です。 元来は英語圏の出版業界において、原稿に組版情報を書き加えていく作業をmarking upと呼んでいたことに由来するようです。[wikipedia-markup] 代表的なマークアップ言語には、以下のようなものがあります。 HTML ウェブブラウザ上で、意図したレイアウトで文書を表示する用途に使われている。 XML HTMLと同様にウェブブラウザで表示する文書のレイアウト指定の他に、汎用的にデー…

はじめに こんにちは！イノベーションセンターテクノロジー部門 GPU-K8s Projectに二週間、インターン参加させていただいた石本直也と申します。 大学院では、WebAssemblyに関するObservabilityについて研究をしています。 今回の職場体験型インターンシップでは「モダンなICTインフラを支える技術の検証・開発（クラウド, コンテナ or データ基盤領域）」をテーマとして以下のことに取り組みました。 GPU ServerのWorker Nodeとしての設定(cuda,containerd,NVIDIA Container Toolkit) K8sクラスタへのGPU Wor…

記事を翻訳してるサイト無いのでここで投稿していこうと思います。 2023.03.28ランチャーに投稿された記事の翻訳です。 ※誤訳がある可能性があります 指揮官の皆さん！ ご存知の通り、EBRCジャガーAFVはエクリプスバトルパス（近日発売予定）のオーバープログレッション賞品として登場します。本日は、その開発状況や、開発の一端をお伝えしたいと思います。 この車両に関する前回の記事では、そのコンセプトについて触れました。基本的には、プログレッションのTier 10 Sphinx AFVと対をなすもので、オートキャノン用の40mm PELE弾薬などいくつかの特殊な特徴を備えており、特にPvEではか…

recognition/voice-input-sphinx) Python の SpeechRecognition で CMU Sphinx を使用して音声入力してみました。 そのままでは認識率が悪いので音響モデルの適応をして認識率を上げました。 音響モデルの適応のやり方を紹介します。