Sphinx 10周年に寄せて #sphinx10th - Hack like a rolling stone
本日、Sphinx-1.7.2 をリリースしました。いくつかのバグが修正されているので、試してみてください。 pypi.python.org さて、リリースするまですっかり忘れていましたが、本日 3月21日は Sphinx の誕生日です。しかも、なんと 10周年です。 Release 0.1.61611 (Mar 21, 2008) ================================ * First public release.github.com Sphinx と僕の (だいたい) 10年間 僕が Python を使いはじめた頃から、既に Sphinx はよく使われていたので、かなり古くからあるツールだと思っていたのですが、実は 僕の Python 暦(2010年ごろ)とそんなに変わらないのですね。実際、Python を使いはじめた頃に 0.6.6 を使ってみたり、1.0
Sphinx に mypy の type annotation を導入した話 - Hack like a rolling stone
今年はアドベントカレンダーにも参加していないし、こたつに入ってだらだら過ごそうかと思っていたら、なんか書けと煽られました。年末ですね。 @tk0miya qiita の記事まだー？— Tetsuya Morimoto (@t2y) 2016年12月25日 何を書こうか思考をめぐらした結果、mypy を Sphinx に導入した話でも書くことにします。 mypy については @t2y の 紹介記事 、翻訳記事が非常に参考になりました。 ですので、この記事は @t2y へのアンサーソングです。 なお、「導入した話」と名付けてはみたものの、まだ 100% 対応したというわけではないので、試行錯誤の様子と愚痴を書き留めていきます。 Sphinx に type annotation をつけてみた Sphinx では現在、 master ブランチに対して type annotation がつけられてい
自分用技術メモの作成が捗ったSphinxのあれこれについて - Qiita
はじめに この記事はHamee Advent Calendar 2016の17日目の記事です。 少し前から個人的にSphinx（Python製のドキュメンテーションツール）に触れていて、試しに自分用の技術メモの作成にSphinxを使ってみたら思った以上に捗ったので、その際に使った機能や拡張機能について書いていきます。 注意 この記事ではSphinxの詳細についてはほとんど紹介しません。 あくまで**こんな機能・拡張機能を使ったら便利だったよ！**といった ポエム 内容の記事となっていますので、あらかじめご了承ください。 TOCツリーのおかげで見通しが良く管理しやすい メモを1つのファイルに書いていくと、あれもこれもと書いているうちに次第に内容が膨大になっていき、後で振り返りをしようと思ったらメモが読みづらいとか内容を追加しようと思ったらどこに何が書いてあるかわかりづらい…なんてこともあるか
Sphinx: sphinx-autobuild で執筆作業の効率を上げる - CUBE SUGAR CONTAINER
先日 SphinxCon JP 2015 で発表の機会に恵まれたんだけど、意外と sphinx-autobuild について知られていなかったようなのでブログにも書いてみることにする。 まず、内容を確認するのに HTML を使っている場合、通常であれば Sphinx の執筆作業は以下の工程の繰り返しになるとおもう。 この繰り返しは本当にめんどうくさいから、執筆への集中を阻害する原因になる。 ドキュメントのソースファイルを編集する Sphinx でビルドする ブラウザにフォーカスを移す ブラウザをリロードする 内容を確認する そこで sphinx-autobuild を使うと (2) から (4) までの作業を自動化してくれる。 これで執筆に集中できるから効率も上がるというもの。 使ってみよう 検証した環境には Mac OS X を使っている。 $ sw_vers ProductName:
WEB+DB PRESS vol88にMQTTの記事を書きました — そこはかとなく書くよん。 ドキュメント
WEB+DB PRESS vol88にMQTTの記事を書きました¶ 2015年8月22日発売の WEB+DB PRESS vol88 に 速習 MQTT というタイトルでMQTTに関する記事を書かせていただきました。 内容は以下の通りです。 MQTTとは MQTTの利用場面 MQTTの特長 その他のプロトコルとの比較 MQTTを使ってみる 速習、というタイトルの通り、利用場面や特長の説明がメインの、MQTTという聞きなれないプロトコルの内容を一通り説明する内容になっています。一応MQTTを使ってみる、という箇所でMQTTを使うアプリをpythonで実装してみていますが、 eclipse paho のおかげもあり、非常に短い行で実装が完了しており、分量は正直あんまりです。 最近すっかりバズワード化してしまい、「MQTTはIoT時代の主役となるプロトコルだ」「MQTTで全部できる」というような
Shibu's Diary: SphinxCon JP 2014でOktaviaの宣伝してきた
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 スタッフ、会場提供のVoyage Groupさま、参加者のみなさま、お疲れ様でした。スライドのビュー数も一晩で2300超えと、今までSlideshareに上げたスライドの中では一番伸びがいい気がします。PyCon JPの時の発表を日本語で再演するのでいいから出てください、と言われてたのですが、末永さんの検索本もちょうど直後に出てて説明省けたし、転置インデックスの検索の説明はざっと削って、あらたに進捗をちょびっと足しました。 SphinxCon記念で、Sphinxユーザに便利かもしれないリポジトリ作ったよ。 https://t.co/XnvZy5OBZG #sphinxjp — 渋川よしき (@shibu_jp) October 23, 2014 イベントの前に、こんなリポジトリ
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
Sphinx Advent Calendar 7日目: 異なった環境で Sphinx と blockdiag とかを使う — takanory.net
現在の場所: ホーム → takalog → Sphinx Advent Calendar 7日目: 異なった環境で Sphinx と blockdiag とかを使う 2012年12月24日(月・祝) 開演14:00(開場13:30) 入場無料、全席自由 南大沢文化会館 主ホール(京王相模原線「南大沢駅」より徒歩3分) 冬から春にちなんだ曲と、クリスマス・ソングを演奏します 主な曲目: おおみそか、花のワルツ、ナイトメア・ビフォア・クリスマス、クリスマス・フェスティバル 演奏会の詳細はこちら 書いた本 Plone 完全活用ガイド の Chapter 1, 2, 3, 11 を執筆しました。 plone のインストール、使い方から、機能・デザインのカスタマイズ、プロダクトの作り方まで、 plone のすべてがぎゅっと詰まっている書籍になっていると思います。 plone に興味が
ReStructuredText 入門
以下の文章中に "(quickref)" という形式のリンクがあります。これは、 Quick reStructuredText ユーザリファレンスへの相対リンクです。このリンクが 切れている場合は、 オンラインのクイックリファレンス を参照してください。 構造 まずはじめに、"Structured Text" （構造化されたテキスト）という呼び方には、 いくぶん不適切なところがあると指摘しておきます。実際には、首尾一貫したパターンを使う "Relaxed Text" （形式ばらないテキスト）とでも呼ぶべきものです。そのパターンを HTML コンバータで変換することで、WEB ブラウザで扱えるような「非常に構造化された テキスト」が生成されるのです。 最も分かり易くて基本的なパターンは、 パラグラフ（段落） (quickref) です。 （1つ以上の）空行で区分されたテキストのひとかたまりが
Sphinxの過去と、未来
Sphinxの過去と、未来¶ 著者: Georg Brandl 日付: 2012/12/25 原文: Sphinx, past and future 翻訳: @r_rudi, @shimizukawa このエントリーは日本語の Sphinx Advent Calendar 2012 に参加してくれないかというリクエストに応えて書いています。彼らはすごいよ！彼らは今年Sphinx Conferenceを開催して、イベントには70人もの人たちが集まったんだ！ Sphinx はいまや5歳になってるし、たぶん今までの歴史を振り返り、将来を語るのに良い時期じゃないかな。 このプロジェクトは2007年前半のいつ頃かに始まった。この投稿は私がPythonメーリングリストで見つけた中で一番古い。この時、Pythonのドキュメント作成のためのソースはLaTeXで書かれていた。私は科学的な文章を書くときには絶
Shibu's Diary: Sphinx-Users.jpを作った時のお話
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 taken by jcolman under CC BY-NC-SA 缶切りでツナ缶を開けようとしたら、缶切りの方が耐久度が低くて壊れたり、パン粉を作るためにプラスチック製のおろし金でパンをすりおろしたら、おろし金の方が削られてツルツルになってしまうような修羅の国アメリカで仕事しています。 僕が日本にいたときに設立したSphinx-Users.jpは代表が変わったあともMLで活発な議論が行われたり、イベントが定期開催されたり、うまく離陸して活動が継続しています。また、当初のもくろみ通りに、単にツールの使い方だけではなく、ドキュメントとは何か？どう書くべきか？ということを考えて発表してくれる人も増えています。 Sphinxのアドベントカレンダーということで、コミュニティについて話
omakeもmakeも使わずに、Sphinxドキュメントの継続的ビルド - Study08.net 対シンバシ殲滅用人型機動兵器
新年あけましておめでとうございます。昨年一年は自分の(体重の)成長を実感できて大変残念ですね。この野郎。今年一年は減量の方ももうちょっと頑張ろうな。俺。 というわけでタイトルの話です。既にSphinxドキュメントで「.rst」ファイルが更新されたら、自動的にビルドを走らせる方法は偉大なる先人達の手によってとっくに道が開拓されているのですが、あえてまた開拓したいと思います。というか他の方法を僕がちゃんと理解できなかったので、僕の知ってる一番簡単な方法でやってみました。 先人達の足跡 特にやり方が決まってるいる話ではないので、omakeが好きな人、Makefileだけでやりたい人とかは下記記事が参考になると思います。 OMakeでSphinxドキュメントをビルドする - 偏った言語信者の垂れ流し omake を使わずに、Sphinx ドキュメントの継続的ビルド: Addicted To Ind
はやわかり reStructuredText
本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は
Sphinx で自動的にAPIリファレンスを作成したい - Study08.net 対シンバシ殲滅用人型機動兵器
今日はこのネタです。タイトルの通りなんですが、PythonでそもそもAPIリファレンス的なドキュメントをどうやって作ったら良いのか知りませんでした。 他の言語であれば下記のようなツールを過去に使った事がありました。 Java なら Javadoc Perl なら pod2html PHP なら PHPDocumentor (今ならもっと賢いツールありそうだけど。。。) Pythonなら? ではPythonであればどのような選択肢があるでしょう。調べた限りではまず下記のような選択肢がありました。 pydoc -w でHTML生成 (pydocで簡単なPythonファイルのドキュメントを作成する) Epydocを利用する (Epydoc - 偏った言語信者の垂れ流し) javadocやらphpdocmentorやらのように、まるっとソースからHTMLを生成するだけであれば、これで十分かもしれま
PythonでWebアプリつくるのにDotCloudに登録しない手はない - YAMAGUCHI::weblog
はじめに サエンバイノー（こんにちは）、Python界のメンソレータムです。さて猫も杓子もクラウドの時代ですが、みなさんいかがお過ごしでしょうか。先日ふと「DotCloud」というサービスを見かけてベータ登録したので、ご紹介致します。 DotCloudってなに？ dotCloud - One home for all your apps DotCloudはいままでWebアプリケーションホスティングサービスの中で期待されていた領域に切り込もうとしてますよ。まず使える言語はPHP, Ruby, Python, Javaがいまのbetaの時点で使えて、さらにこれからリクエストがある言語にも対応しようとしてます。（ErlangとかSchemeとか）で、DBとかMQとかすでに有名所はいくつか使えて、なんでもリクエストがあれば対応するぜ！っていう勢い。またスケールに関してもスケールアップ、スケールアウ
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
https://www.freia.jp/taka/blog/sphinx-dev-remove-2to3/index.html
機械学習の Python との出会い — 機械学習の Python との出会い
Home — mens-pdf
Python 3 Patterns, Recipes and Idioms — Python 3 Patterns, Recipes and Idioms
Kroger氏、Python系ドキュメント制作ツール「Sphinx」を使った電子書籍ワークフローを紹介 | デンショイチバ