remarkdown を巡る冒険 (原題: remarkdown versus Sphinx) - Hack like a rolling stone
docutils はある形式の文書を別の形式に変換するフレームワークです。 このフレームワークを利用して rst2html や rst2latex などが提供されています。 しかし、docutils が標準で対応している入力形式は reST 形式に限られているので、 実際には reST 変換用のライブラリとして捉えられていました。 markdown 黄金時代 docutils や Sphinx の周囲では reST を中心としてドキュメントが記述されていますが、 2014年現在、軽量マークアップ言語の主流の座は markdown であると言っても過言ではないでしょう。 flavor が乱立していたり、拡張性に乏しかったり、困ったら HTML で書き下してあったりと、 記述能力が十分とはいえない markdown ですが、github を初めてとして様々な場所で用いられています。 4月1日は
New features of autodoc in Sphinx-2.4 - Hack like a rolling stone
Today, I released Sphinx-2.4.0, now available on the Python package index at https://pypi.org/project/Sphinx/. It includes 18 new features and 23 bugfixes. For the full changelog, go to http://www.sphinx-doc.org/en/master/changes.html. In this article, I'd like to introduce you to new features of autodoc. Support type annotations for variables Until now, autodoc did not document type annotations f
2019年を振り返る / 2020年の抱負 - Hack like a rolling stone
あけましておめでとうございます。春節がやってきて2020年のはじまりを感じますね。 他のことをやっていたので抱負エントリを書くのを忘れていたのですが、1月で旧正月なのでまだセーフです。 さて、さっそく去年を振り返ることにしましょう。 2019年の抱負 として挙げたのは Sphinx のメンテナ活動をがんばる なにか使えるツールをリリースする (少なくとも一本以上) 技術書を読み続ける。時間を取る。 家の片付け 新しい技術へのチャレンジ の5個でした。 それぞれについて振り返ってみましょう。 Sphinx のメンテナ活動をがんばる：△ 745コミット。去年が 917コミットだったので、ちょっと減ってしまいましたね。 8月末に引っ越しがあって、その前後に活動をほぼ停止してしまったのが効いています。 また、9月は技術書典にも参加していたので、ほぼコミット数が止まってしまいました。 ずっと目標にし
JBL の LINK BAR (AndroidTV 搭載サウンドバー)は買ってはいけない - Hack like a rolling stone
少し前に JBL のサウンドバー、LINK BAR というのを買ってみた。サウンドバーというのはあまり馴染みがなかったのだけど、テレビの前とかに設置するタイプの横長の(バー状の)スピーカーのこと。 JBL ANDROID TV・GOOGLE アシスタント搭載サウンドバーJBL JBL LINK BAR 出版社/メーカー: JBLメディア: エレクトロニクス この LINK BAR、他のサウンドバーと少し違っていて、AndroidTV と Google アシスタントを積んでいるのが特徴のシロモノ。 そのため、こいつをテレビに繋ぐといろんなことができる。 chromecast の代わりになったり AndroidTV 向けのアプリを動かしたり (家電などの)音声操作をしたり テレビの音をスピーカーとして流したり bluetooth で音楽を流したり LINK BAR はこういう特徴を併せ持ったオ
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 コードの半減期と未来予想図 - Hack like a rolling stone
Twitter で流れてきた コードの半減期とテセウスの船 | 開発手法・プロジェクト管理 | POSTD を読んで、興味深かったのでさっそく Sphinx のコードでも実行してみました。 その結果がこちらです。 コードの増え方は時期によって波がありますが、やはり Sphinx もコードの量は右肩上がりに増えています。そして、古いコードは徐々に整理されて少なくなっています。 面白いのは、生き延びた古いコードはある程度安定しているためか、削除されることが少なくなってきている一方で、新しく追加されたコードは入れ替わりが激しい傾向が読み取れます。 Sphinx はまだコードの追加と削除が繰り返される、活発なプロジェクトだということがわかります。 モジュールごとの半減期 さて、せっかくの機会ですから、別の角度からも見てみましょう。 このグラフは Sphinx の主要モジュールの年代ごとのコード比率
Google 図形描画で書いた図を取り込む sphinxcontrib-googledrive をリリースしました。 - Hack like a rolling stone
ひとつ前の記事で書いた『マスタリング docutils』では、作図に Google 図形描画を使いました。 以前は Cacoo を使ったり、Inkscape を使ったりしていたんですが、維持するのにお金が必要だったり、 CI 環境を作るのが面倒くさかったりして、今回は Google 図形描画を使うことにしました。 あまり図が複雑ではなかったのと、手軽に書きたかったというのも、ツール選びに関係していそうです。 執筆中は時間もなかったので、書いた図は手でエクスポートして貼り込んでいましたが、いま振り返ると先にこのツールを作っておけばよかったと思います。 なにせ、図を書き換えるたびに 1. エクスポートして 2. (余計な空白が入るので) ImageMagick でトリミングして 3. リネームして特定の場所に置く というのを手動で実行する必要があるのです。 『マスタリング docutils』で
(24日目) schema2rst と Sphinx でお手軽データベース定義書作り - Hack like a rolling stone
ここ数日 blockdiag の話が続いていましたが、久しぶりに Sphinx の話に戻ります。 僕は Sphinx を使ってお仕事のドキュメントを書いているので、 ドキュメントのひとつとしてデータベース定義書を書くことがあります。 このデータベース定義書、みなさんはどうやってメンテナンスしていますか? 以前、僕のチームでは Excel で定義書を作っていたのですが、 定義書と実際に稼動しているスキーマが異なることが稀にあり、 混乱が生したり、ちょっとしたトラブルの元になることがありました。*1 よく考えてみると、データベース定義書とスキーマを二重に管理しなくてはならないので、 どこかで同期に失敗すると(更新忘れなど)そこに差ができてしまうのは自明なことです。 一部の企業では Excel から DDL を書きだすようなマクロを持っているそうですが、 差分更新ができないなどでうまくメンテナン
Sphinx のメンテナになって一年が経過した話 - Hack like a rolling stone
クリスマスが過ぎてから始まる Sphinx アドベントカレンダーへようこそ (嘘) Sphinx 大型連載第二夜です。 タイトルにある通り、Sphinx のメンテナ活動をして一年が過ぎたので、その話をします。 OSS 開発者のひとつのサンプルケースとして、何かの参考になれば幸いです。 Sphinx のメンテナ活動をはじめました 去年の 12月から Sphinx のメンテナ活動をはじめました。 Python のリリースマネージャ活動が忙しかったからか原作者の Georg の活動が鈍り、 また、その後を継いだ清水川さんも忙しくて身動きが取れなくなっていたことから、 コミット権をもらっていたことだし、パートタイムで手伝うかと思ったことがきっかけでした。 以前からコミット権は持っていたものの、一切メンテナとしての活動をしていなかったので、 徐々にチケットが溜まっていく様子に後ろめたくなったのかもし
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
