ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
ぼくのかんがえたさいきょうのQiitaメモ - Qiita
概要 ローカルでメモを取りつつカジュアルにQiitaに投稿できるようにしたい。 メモはSphinxでbuildできて手元で参照しやすくしたい。 Alfred + Dashでも検索できるようにしたい。 メモはVimで書きたい。 Markdown記法で書いてもいい。 という欲求を満たすための環境構築メモ やりたいことイメージ図 Markdownで色々メモる Sphinxでbuildする Sphinxドキュメントをブラウザで見れる Kobitoとファイル連携しつつ、KobitoからQiitaに投稿 SphinxドキュメントをAlfred+Dashから素早く検索 環境 OS X Marverics Python2.7 virtualenv(virtualenvwrapper) pip Sphinx homebrew Pandoc Apache Kobito.app <= 1.9.2 Kobito
第3回 EuroPython 2015参加レポートと、Sphinxに関する発表（前編） | gihyo.jp
清水川です。 2015年7月20日（月）～26日（日）にかけて、スペインのビルバオでEuroPython 2015が行われました。EuroPythonは毎年ヨーロッパ地域で行われるPythonカンファレンスで、今年は14回目の開催です。最初の開催は2002年で、世界で初めてボランティアによって開催されたPythonカンファレンスです。アメリカで開催されているPyConよりも、1年早く開催されたんですね。 EuroPython 2015 EuroPythonの開催地は、ヨーロッパ各国からの立候補を受けて、EuroPython Societyのボードメンバーが決定します。昨年はドイツのベルリンで開催され、日本人は筆者を含む4人が参加しました。今年は日本からは筆者のみの参加でした。 本記事では、EuroPython 2015の様子について2回に分けて紹介します。今回は、開催都市について、カン
pandoc で Redmine の Wiki を Sphinx に変換しよう - secretbase.log
Sphinx Advent Calendar 2012 - connpass の 15日目のエントリとなります。本日は、pandocというドキュメント変換ツールの紹介です。 Sphinx を使う場合、reSTにてドキュメントを記述しますが、例えばプロジェクト管理にRedmineを導入している場合、Wikiに書きためた文章があるかと思います。RedmineのWikiは textile 記法なので、reSTにうまく変換する方法があったらいいと思いませんか？ そんな textile を reST に変換してくれるツールとして使えそうな pandoc を紹介したいと思います。 pandoc とは pandoc は、ユニバーサルドキュメントコンバータです。 textileだけではなく、入力フォーマットとして、markdown, HTMLなどいろいろあり、出力も reST, markdown はもちろ
Sphinx再入門（Sphinx+翻訳 Hack-a-thonにて） - Edo::Blog
Sphinx+翻訳 Hack-a-thon 2015.01 - connpass 参加時に書いたエントリーです。 参加のきっかけ Sphinxは1年前くらいに触ってみたものの、その後、利用機会がなく使い方を忘れてしまう... 今回再チャレンジを検討してみるも、再度挫折しそうな気もするので、本イベントを利用させてもらって集中的に取り組もうと考えた。 ※ イベント名にはハッカソンってなっているけど、参加対象／趣旨は下記の通りで参加しても問題なさそう（問題なかった） 主に以下の方を対象にしています。 Sphinx で文章を書きたい/書いている人 ドキュメントの執筆/翻訳をしている人 ( Sphinx を使ってなくても ok ) Sphinx のハック(改良、拡張づくり、テーマづくりなど)をしている人 Sphinx に興味がある/使ってみたい人 その他ドキュメントに関する素敵ななにか (all t
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 イベントの前に、こんなリポジトリ
コードサンプルの表示 — Sphinx 1.4.4 ドキュメント
コードサンプルの表示¶ Pythonのソースコードや、インタラクティブモードのセッションを表現するのには、標準のreSTのリテラルブロックを使用します。リテラルブロックは前の段落の末尾を :: にして、インデントにすることで開始されます。 インタラクティブセッションの表現には、プロンプトと、Pythonコードが表示する出力も含める必要があります。インタラクティブセッション用の特別なマークアップはありません。最後の行の後、もしくは出力を書いているところには、”未使用の”プロンプトは置いてはいけません。下記の例は しないほうがいいもの の例です。: シンタックスハイライトは Pygments によって行われ、無駄のない方法で制御されます: ソースファイルごとに”ハイライトする言語”があります。一番ハイライトされる言語として多いのはPythonのコード片なので、デフォルトでは 'python'
sphinx で ValueError: unknown locale: UTF-8 というエラーが出た
uvbook を読もうと思って make html したら ValueError: unknown locale: UTF-8 という例外がでてビルドできなかった (dev)[12:34 kosei@mba uvbook]% make html sphinx-build -b html -d build/doctrees source build/html Traceback (most recent call last): File "/Users/kosei/.virtualenvs/dev/bin/sphinx-build", line 9, in <module> load_entry_point('Sphinx==1.1.3', 'console_scripts', 'sphinx-build')() File "/Users/kosei/.virtualenvs/dev/lib
Sphinxで打ち消し線を使う | Webシステム開発／教育ソリューションのタイムインターメディア
Sphinx プロジェクトのディレクトリに以下の内容を sphinxcontrib_roles.py という名前で保存します。 ここでは strike、red という二つのロールを定義しています。 CSS の定義でそれぞれ打ち消し線表示、赤い文字にする、という表示にしています。 あとは reST 本文の中でこれらのロールを指定するだけです。 たとえば :strike:`ここは打ち消し線表示` と書いて HTML ファイルを生成すると 以下のように出力されます。 HTML 以外のフォーマットでは効果がありませんが、 HTML 出力はよく使われると思うので程よくマークアップすると良いと思います。 ただ、見た目ばかりに気を取られると Sphinx(reST) のメリットが薄れていくのでご注意を。
「Sphinxをはじめよう」を読んで導入したいと思ったので色々考えてみた - kk_Atakaの日記
あらすじ 今までちびちび触ってきたが「Sphinx をはじめよう」を読んで、改めて Sphinx を導入したいと考えた。 そこで、今の環境でどうやったら導入できるのか色々考えてみたが、相談できる人もいないのでここにアップしてみる。 本当は説得材料をつらつらと上げて「だから試してみよう」ってところに持って行きたかったんだけど、そこまでは行けていない。ダラダラ書いている。 テーマ 適材適所 決して Office ディスではなく。色々なツールが適材適所で LET US CLING TOGETHER できる道を考えたい。 結論 ドキュメント Sphinx 複雑な表や表計算が必要な資料 Excel で別添資料扱い？ その他こまい文書 Redmine とかの Wiki に書き換え って分けられると、幸せになれると考えている。。 Word は…思いっきり Sphinx と競合する気が…。 現在の己の認識
オープンソースの検索エンジン Sphinx について調べたメモ - 観測所日誌
"全文検索について簡単に調べたメモ" 続き 注意点としては 日本語は UTF-8 一択 検索対象 DB も UTF-8 だと楽 Ngram のみ インデックスの部分的な更新に難あり blog, ニュース, フォーラムといった蓄積型のコンテンツには良い 更新柔軟性よりパフォーマンスやスケールを取っている 今後、別方式のインデックスを実装するプランはある ライセンスは GPL v2 or 商用（embeded 用） 概要 ドキュメント を読んだメモ。 検索 document は複数の field を持ち、また検索用メタ情報である attribute を持つ。 field は検索に用いられる index 対象となるフィールドであり、Sphinx はこのフィールドを複数個持てる（デフォで上限32個？） attribute はソートや、グルーピング、検索結果の絞り込みに使われる。詳細は 3.2 At
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
(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
儲かるドキュメント
Sphinx is a documentation generator that can create HTML and other formats from reStructuredText markup and Python docstrings. It supports features like automatic cross-referencing, built-in search, and the ability to extend and customize the templates. Documentation built with Sphinx can be hosted on sites like ReadTheDocs for easy web hosting of project documentation.Read less
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
note.sicafe.net / Sphinx Memo — Sphinx Memo 2012/06/02 documentation
箇条書きぶら下げルール / reStructuredText, docutils
Sphinxの全文検索を複合語に強くする
excale.net
Sphinxにおける数式のサポート — Sphinx v1.0 (hg) documentation