Sphinx Con JP 2015での発表 目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。 （当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。）
ドキュメントシステムはこれを使え2015年版
Sphinx Con JP 2015での発表 目的からドキュメントシステムを選べるYes/Noチャートは33ページにあります。 （当初アップロードしたものはこのページにミスがあったので差し替えています。高橋さんありがとうございます。）
Shibu's Diary: Sphinx-Users.jpを作った時のお話
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 taken by jcolman under CC BY-NC-SA 缶切りでツナ缶を開けようとしたら、缶切りの方が耐久度が低くて壊れたり、パン粉を作るためにプラスチック製のおろし金でパンをすりおろしたら、おろし金の方が削られてツルツルになってしまうような修羅の国アメリカで仕事しています。 僕が日本にいたときに設立したSphinx-Users.jpは代表が変わったあともMLで活発な議論が行われたり、イベントが定期開催されたり、うまく離陸して活動が継続しています。また、当初のもくろみ通りに、単にツールの使い方だけではなく、ドキュメントとは何か？どう書くべきか？ということを考えて発表してくれる人も増えています。 Sphinxのアドベントカレンダーということで、コミュニティについて話
(6日目) Sphinx 拡張の紹介 - Hack like a rolling stone
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
(2日目) blockdiag のインストール〜使い方 (Debian 編) - Hack like a rolling stone
こんばんは、Sphinx & blockdiag アドベントカレンダー 2日目です。 昨日は Sphinx をインストールして使ってみるという流れを紹介しました。 今度は blockdiag を試してみましょう。 blockdiag とは? blockdiag は僕こと @tk0miya が開発した画像生成ツールです。 テキストで定義された図を画像ファイルに変換することができます。 blockdiag は目的別にいくつかのパッケージに分かれています。 blockdiag ブロック図、フローチャート、画面遷移図などを記述する seqdiag シーケンス図を記述する actidag アクティビティ図を記述する nwdiag ネットワーク系の図(論理ネットワーク図、ラック構成図)を記述する ドキュメントの図を作る際は MS-Office (Excel, PowerPoint)、Visio、Cac
reStructuredText入門 — Sphinx v1.0 (hg) documentation
reStructuredText入門¶ このセクションは、reStructuredText(reST)の考え方や文法についての短いイントロダクションです。Sphinxユーザがドキュメントを作成するために十分な情報を提供します。reSTはシンプルに設計された、控えめなマークアップ言語ですので、理解するのにそれほど時間はかからないでしょう。 段落(パラグラフ)¶ 段落はreSTドキュメントにおける、もっとも基本的な要素です。段落は1行以上の空行で区切られた、シンプルなテキストの固まりです。 Pythonにおいてインデントが重要な意味を持つのと同様、reSTでもインデントは重要です。同じ段落のすべての行は、インデントを同じ高さにそろえて、左揃えにしなければなりません。 インラインマークアップ¶ 標準のreSTインラインマークアップは極めてシンプルです。 アスタリスク1つ: *テキスト* 強調(
Shibu's Diary: Sphinxの検索を日本語対応にする
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 写真は内容とは関係なく、栃木県宇都宮市のスフィンクスです。闇夜にいきなり現れるとかなりコワイです。 Sphinxの検索機能の日本語対応をしてみました。リンク先にはパッチ済みのSphinxが置いてあります。Sphinxは検索関連に関しては、かなり英語にハードコードされていましたので。やったことは以下の通り。 日本語対応のSplitterの作成 設定オプションに検索言語切り替えを追加 stemmingアルゴリズム、 stop wordsも検索言語と連動して切り替わるように変更 Sphinx-devのメーリングリストに、機能拡張要望をメール 日本語対応のSplitterの作成 まずやってみたのはSplitterの作成。Sphinxでは欧米言語を想定しているので、re.compile(
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
[Sphinx-Users 240] Re: reST の編集にどんなエディタを使っていますか？