Hatena Blog Tags
はてなブログ トップ
Sphinx
このタグでブログを書く
言葉の解説
ネットで話題
関連ブログ

Sphinx

(コンピュータ)
【すふぃんくす】

Pythonによって作られたドキュメント生成ツール。

Pythonの公式ドキュメントもSphinxが利用されている。

このタグの解説についてこの解説文は、すでに終了したサービス「はてなキーワード」内で有志のユーザーが作成・編集した内容に基づいています。その正確性や網羅性をはてなが保証するものではありません。問題のある記述を発見した場合には、お問い合わせフォームよりご連絡ください。
nikkie-ftnextの日記•4 か月前

sphinx-revealjsで作ったスライドをGitHub Pagesで公開する

はじめに 聞いて聞いて！ nikkieです。 先日以下のように書きました。 sphinx-revealjsいいと思うので、皆さんに使ってほしく、筆を進めねば・・ https://nikkie-ftnext.hatenablog.com/entry/yapc-japan-online-2022-awesome-talks#fn:5 こちらを実現させていきます。 まずは一番単純なトピックから。 sphinx-revealjsで作ったスライドをGitHub Pagesで公開する方法を共有します！ ちなみに私の登壇資料は、2021年からsphinx-revealjs × GitHub Pagesという…

#Sphinx#sphinx-revealjs#GitHub Pages#GitHub Actions

ネットで話題

もっと見る
274ブックマークSphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jpsphinx-users.jp
183ブックマークOverview — Sphinx v1.0 (hg) documentationダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づい...sphinx.shibu.jp
173ブックマークドキュメントを作りたくなってしまう魔法のツールSphinxwww.slideshare.net
148ブックマークSphinx-Users.jpsphinx-users.jp
139ブックマークRead the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみるrcmdnk.com
126ブックマークOverview — Sphinx v1.0.7 documentationWhat users say: “Cheers for a great tool that actually makes programmers want to write documentation!“ Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license. It was originally created for the Python docume...sphinx-doc.org
95ブックマークSphinxをはじめようwww.oreilly.co.jp
95ブックマークJenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIOdev.classmethod.jp
80ブックマークドキュメントを作りたくなってしまう魔法のツール「Sphinx」www.slideshare.net

関連ブログ

日々ブログ•4 か月前

【プログラミング】技術ドキュメントを作成するsphinx を使ってみた感想

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

#使ってみた感想
gxliuのブログ•9 か月前

Sphinxとsphinx-revealjsの勉強

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

#Sphinx#sphinx-revealjs#documentation
nikkie-ftnextの日記•昨年

Sphinxでクロスリファレンスを機能させるためには、includeするファイルをrst以外の拡張子にすべきと身をもって学びました

はじめに 頑張れば、何かがあるって、信じてる。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…

#Sphinx#PDF
aptpod Tech Blog•2 年前

SphinxでPDFを出力するときに、表紙タイトルの折り返し位置を指定する

弊社では最近、PDF形式のドキュメントを作成するためにSphinxを使っています。1 Sphinxを使って、reStructuredTextからPDFを作成する 例えば、弊社では先日AWS Marketplaceにてintdash LE All-in-Oneをリリースしましたが、そのドキュメントはSphinxで作成しました。 intdash概要 AMIを使ったintdashサーバー構築手順 Sphinxは非常に使いやすいツールですが、本格的に使うようになってから気づいた、使いこなしのコツやノウハウがいくつかあります。 その1つとして今回は、表紙タイトルの折り返しについてご紹介したいと思います。…

#テクニカルライター#Sphinx
aptpod Tech Blog•2 年前

SphinxとLuaLaTeXで、日本語PDFマニュアルを作る

アプトポッドにて、テクニカルライターとして製品マニュアルの制作を担当している篠崎です。 現在弊社では、製品マニュアルの制作に、Sphinxを導入しようとしています。Sphinxは、1つの原稿ファイルからHTML、PDF等を出力できるドキュメントジェネレーターです。この記事では、SphinxにLuaLaTeXを組み合わせて日本語PDFを生成する方法を探ってみました。 背景 SphinxでLuaLaTeXを使う設定 (A) LuaLaTeXを使用する (B) LaTeXドキュメントクラスとしてltjsbookを使用する (C) Polyglossiaパッケージを読み込まないようにする (D) サン…

#Sphinx#lualatex#テクニカルライター
ブログ | 知的好奇心ラウンジ•11 日前

アヌンナキ、古代の神々

アヌンナキ、古代の神々 (図 Alien Pixabay by Jim Cooper) ゼータ・トーク 巨大なヒト(Giant Hominoids) ZetaTalk： 第12惑星、1995年7月15日記載 第12惑星(12th Planet) 第12惑星： 惑星地球への着陸 第12惑星： 天国の王権 ZetaTalk： 地球からの距離、1999年11月15日記載 1983年12月31日のワシントンポスト： ピラミッド(Pyramids) ZetaTalk： グレート・ピラミッド、1995年7月15日記載 ZetaTalk： 秘密のチャンバー[部屋]、1995年11月15日記載 モニュメント(…

Morikatron Engineer Blog•21 日前

Docker + VSCode(Remote Container)でSphinx環境を作り、構造化されたドキュメントを快適に書く

こんにちは。モリカトロンでエンジニアをしている馬淵です。 最近Sphinxというドキュメント作成ツールに関して書かれた下の書籍に興味を持ち、衝動買いしてしまいました。 www.oreilly.co.jp こちらの書籍を読み進める際に環境を用意したのですが、自分なりに工夫を行ったのでこれを共有、メモを兼ねて今回はブログを書こうと思います。 基本的にVSCodeやDockerを既にインストールしている方、または複数人でドキュメントを編集する作業を行う方が対象となります。 Sphinxとは 何故DockerとVSCodeで環境を作ったか 事前準備 設定ファイルを書く Dockerfile requi…

hotch-potch, Note to self•24 日前

気になる書籍・22年6月

興味のある新刊書籍を羅列してます。

たろログ2•先月

2022-06-07 Docker のドキュメントの全体像を把握する

docker を使いこなすために、docker のドキュメントをすべて読もうと思い立った。 実は半年前に途中まで実施したことがある作業。改めて実施する。 半年前に実施した際は終わる見通しが立たず、そのために挫折してしまったため、まずドキュメントの全体像をつかむことにする。 英語版 Guides, Manual, Reference に分かれている。それぞれトップページは以下となる。 Docker overview | Docker Documentation Docker Desktop overview | Docker Documentation Reference documentati…

海外オヤジの読書ノート•先月

大人が味わう童話集　|　『THE CANTERVILLE GHOST, THE HAPPY PRINCE AND OTHER STORIES』著：OSCAR WILDE

ここ数か月、忙しさにかまけて読書ペースが落ちています。本作は英語の本ですが、読了に一か月かかってしまいました。英語の本はどうやったら早く読めるのか？。。。今更単語の暗記とかもしたくないしなあ。。。うーむ。 オスカー・ワイルドという作家をご存じでしょうか。 ん？オリバー・ツイスト？（それはディケンス）、ジョージ・オーウェル？（1984ね）、ジョージ・ルーカス？（大分離れたよ！映画監督ね）…近現代の作家は数多くいらっしゃいますが、本作者、名前はうっすらご存じ、という程度の知名度ではないでしょうか。マイナーとも言えないけどメジャーというにはちょっと、という世間的位置づけに感じます。 で、オスカー・ワ…

gxliuのブログ•2 か月前

AWS無料枠で1台のEC2上にWordPressを構築

概要 AWSの無料枠を利用して、EC2にWordPressを構築し、ブログを書けるようにする。 サマリー： 項目 内容 EC2タイプ t2.micro。1vCPU, メモリ1GB ストレージ 30GB ELB ALB LAMP Amazon Linux2 / Apache2.4.53 / MariaDB10.5.10 / PHP8.0.16 WordPress 5.9.3 プロトコル HTTP/HTTPS 前提 AWS上無料枠の申込が完了し、ルートユーザーが作成され、MFA認証のセキュリティ設定が完了していること。 手順 IAM（アイアム）ユーザーの作成する Identity and Acce…

Linux あれこれ•3 か月前

「PyCharm」の「Edu Tools」プラグインの学習課題の翻訳にトライ〈H146-4〉

登録日: 2022-04-15 更新日: 2022-05-01 前回、「Python」の開発で使われるIDE の「PyCharm」コードエディタをインストールして日本語化 しました。 - 残念ながら、Python の学習のために追加した「EduTools」プラグインは日本語化の対象外 でした。 英語のままでは学習が進まないので、まずは基本的なコース の「Introduction to Python」（Python の基本）を翻訳してみました。その備忘録です。 - - ホストOS : Xubuntu 20.04.4 LTS ゲストOS : Lubuntu 22.04 LTS ←（今回の作業） -…

mn36555023’s diary•3 か月前

令和4年4月3日

"beatmania IIDX 25 CANNON BALLERS O/D*20 SPA 正規" を YouTube で見る youtu.be/CGJQOHCXxhgposted at 23:53:20 "[IIDX 1st Style] OVERDOSER(romo mix) / MIRAK" を YouTube で見る youtu.be/ASytcfsxpzYposted at 23:42:28 "[IIDX ROOTAGE] 龍王の霊廟(Mausoleum Of The Primal Dragon) / BEMANI Sound Team "黒猫ダンジョン"" を YouTube で見る…

ホモファーベル庵日誌•3 か月前

クライシスアクター（死体役）をセットするのに約３日かかっている

あら不思議。Buchaの市長がBucha市議会の前でスピーチ。ロシア軍が街を解放したと宣言。３月３１日か４月１日に撮影されたもの。道に転がってる死体や残虐行為について一言も触れていない。市民の死体が道に転がるまで３日もかかったのかしら。🤔 https://t.co/Wt1Jft82Ug— マヨ (@littlemayo) 2022年4月3日 一方で昨日ウクライナが公開した動画ナザレンコ氏が上げてた写真も何で公開がロシア軍が撤退した3日後？って騒がれてたhttps://t.co/zkwC10hIAw— マン・ドリル (@mandril_sphinx) 2022年4月3日

TO travel IS TO live•3 か月前

【奇想のモード 装うことへの狂気、またはシュルレアリスム】東京都庭園美術館

Tokyo Metropolitan Teien Art Museum（March 2022） 20世紀最大の芸術運動であった、『シュルレアリスム』 （※シュルレアリスムとは、『超現実主義』を意味します。「無意識」や「夢」、心の奥に潜む「欲求」など、はっきりした意識のもとではコントロールできない領域のものを表現しようとした流派のことをシュルレアリスムと呼びます。） 参考：シュルレアリスムって？初心者でも大丈夫。作品の楽しみ方をやさしく解説！《やさしいアートの話2》 | thisismedia シュルレアリスムがモードの世界に影響をもたらした、 さまざまな美の表現を紹介する展覧会が、東京都庭園美…

K_DM blog•3 か月前

jupyter bookからHugo+jupyter notebookに移行する

この記事は何？ jupyter notebookのマークダウン化 テーブルが表示されない問題 Google colabの実行ボタン作成 この記事は何？ jupyter bookで作成したページをHugo+jupyter notebookの環境に移行した際に調べた内容です。 まず、移行しようと思った経緯について。 現状のjupyter bookを複数言語対応させようと思った場合Sphinxの機能を活用する必要があるようですが、調べた限りでは言語ごとにgithubのリポジトリを変えて対応している人しか見つけられませんでした。 そのため、hugoにてjupyter notebookを表示して言語切り…

幻の猫たち　改訂版•3 か月前

Lockwood-Top-Vander-Widemann  『Fusion』 

Lockwood-Top-Vander-Widemann 『Fusion』 CD: JMS / Sphinx Distribution JMS 015-2 (2006) 1. GHK GO TO MILES (D. Lockwood - J. Top - C. Vander - B. Widemann) 24:00 2. OVERDRIVE (D. Lockwood - J. Top - C. Vander - B. Widemann) 4:50 3. 767 ZX (D. Lockwood - J. Top - C. Vander - B. Widemann) 6:45 4. RELIEFS…

ユタ州住人(元NY閑人)の浮草考•3 か月前

ハチドリモドキの蛾 Hummingbird Moth

左は掲題の蛾(スズメガ)の写真（借りものです）。 ここ数週間、暖かくなってきたので殆ど毎日パティオで景色を楽しみながら夕食をしています。今日は日中の気温が29℃ぐらいまで上がるらしいです。まるで真夏。 話は一昨日、夕方からパティオで食事をしていた時のことです。夕方と言っても夏時間なのでまだ明るく昼間のようでした。 最近はハチドリが毎日、朝から夕方までネクターを飲みにきます。黒っぽい色と緑の玉虫色の2羽が常連です。カップルかも知れません。相棒が「ハチドリは蜘蛛の巣の糸を利用して自分たちの巣を作る」ということを調べました。そして現に蜘蛛の巣をつつくのを相棒が見ています。 この日、室内にあったレモン…