Linux カーネルでの Sphinx 利用法を見てみよう - Hack like a rolling stone
年末カウントダウン Sphinx 連載、第3弾です。 一切下準備をせずに連載を始めたので、早くも息切れをしています。 だれかと約束をしたわけでもないのに急にアドベントカレンダー的なものを始めるのは、なんだか死に急いでいる気がしてきました。 今回は、今年から Sphinx の利用者に加わったある大型プロジェクトについて紹介しましょう。 そのプロジェクトとは、世界最大級の OSS のひとつである Linux カーネルです。 現在の Linux カーネルドキュメント 今年開催された LinuxCon Japan 2016 で Linux カーネルのドキュメントに Sphinx を使うという発表がありました。 Linus Torvalds氏が登壇、「約10週間のリリースサイクルは続く」 - クラウド Watch それから約 5ヶ月。現在はどうなっているのか見てみましょう。 Linux カーネルのド
SphinxでドキュメンテーションコメントをHTMLに変換する方法
前フリ Pythonにはpydocというモジュールがあって、これを使うと同じようにAPIリストが出力できると思っていた。今までDjangoのコードを書いてみて、いわゆるヘッダーコメントとかドキュメンテーションコメントと言われているものをなんとなくjavadocライクに書いていたが、pydocだとあんまり期待した通りのHTMLを出力してくれないことが分かった。 自分が期待していたのは、 @タグでクラス、関数属性に関する情報を出力 phpDocumentorのように、テンプレートを変更可能 というものだったが、あんまりよろしくなかった。調べてみると、epydocというツールで実現できそうだったが、テンプレートはないらしい。もうちょっと調べてみると、Sphinxというドキュメンテーションツールがあるそうだ。すでに、以前のエントリーでちょっとした使い方について書いたが、インストール方法とかを書いて
Shibu's Diary: ブラウザ上で動く検索エンジンOktavia
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 HTML5アドベントカレンダー向けのエントリーです。ブラウザでできることがどんどん増えています。2013年に一部で熱狂的な話題となった本の高速文字列解析の世界 を読んで意識が高まったので、勢いにまかせてブラウザで動く検索エンジンを作ってみました。写真は著者の岡野原さんにお会いしたときにいただいたサインです。 ブラウザ上の検索エンジンと転置インデックスと東アジアの微妙な関係 全然調べていないので、歴史とかよくわからないのですが、僕が始めてブラウザ上で動く検索エンジンと出会ったのは、Sphinxです。SphinxはPythonで書かれたドキュメントツールです。ドキュメントツールというとJavaDocを始めとして各種あります。大きく、自然言語中心のもの(Texとか)と、APIリファレ
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
Sphinxでサイドバーの検索ボックスをOFFにする - 豆無日記
オンラインヘルプとかHTMLドキュメントを書くのに、すごく便利ですよね、Sphinx。 某アレに提出するためのドキュメントを書いてたんですが、一つだけ困りました。 サイドバーの検索ボックスがあるんですが、なんかうまく動かない。検索が全然返ってこない。 というか、今回の用途としては検索ボックス自体いらないのでOFFにしたいんですが、conf.pyみてもそういう設定はないんですよね。コピーライトとかそういうのは非表示にできるのに。 というわけで、Sphinx本体にちょっと手を入れて検索ボックスを非表示にするようにしてみました。 builders/html.py | 1 + config.py | 1 + themes/basic/layout.html | 8 +++++--- 3 files changed, 7 insertions(+), 3 deletions(-) diff --gi
Sphinxでソフトウェアのドキュメントを書いた時によく使う記法 - oinume journal
最近Sphinxでよくドキュメントを書くのでメモ。やっぱりある程度巨大なソフトウェアのドキュメントを書く時はWikiじゃなくてSphinxの方が良い気がする。 リンク 他のファイルのセクションにリンクを貼るときには そのセクションの前で .. _label: のようにラベル定義 :ref:`label`でリンクを張る という感じ。ラベルの名前はドキュメント全体でユニークにする必要がある。 参考 ソースコードのinclude literalincludeを使う。外部のソースファイルをincludeする時に使った。 .. literalinclude:: ../../src/main/java/net/lampetty/commons/MarkingStopwatch.java :language: java :linenos: 参考 テーブル 通常のテーブルの書き方は非常に面倒なので csv
https://www.freia.jp/taka/blog/sphinx-i18n-translation-procedure-with-transifex-amazon-s3/index.html
reStructuredText Directives
Image Directive Type: "image" Doctree Elements: <image>, <reference> (only with option "target") Directive Arguments: one, required (image URI) Directive Options: see below Directive Content: none Configuration Setting: image_loading (only HTML5 writer) An "image" is a simple picture: .. image:: picture.png The URI for the image source file is specified in the directive argument. As with hyperlink
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinx autodoc� - automated API documentation (PyCon APAC 2015 in Taiwan)
Oktavia全文検索エンジン - SphinxCon JP 2014
https://sphinx-users.jp/doc10/domains.html
sphinxcontrib-github
Added new Sphinx extension to auto-link issue numbers by astrofrog · Pull Request #2101 · astropy/astropy
releases
GitHub - readthedocs/sphinx_rtd_theme: Sphinx theme for readthedocs.org
https://github.com/readthedocs/readthedocs.org/blob/master/docs/conf.py
Pocket - My list
sphinx-better-theme
https://sphinx-users.jp/doc11/templating.html
https://sphinx-users.jp/doc11/intl.html