ドキュメントを作りたくなってしまう魔法のツール「Sphinx」Who is the person whom the IT engineers should learn next to Alexander?Yoshiki Shibukawa
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
Sphinx本の執筆体制について — そこはかとなく書くよん。 ドキュメント
Sphinx本の執筆体制について¶ この記事は ドキュメンテーション Advent Calendar 2013 の4日目の記事です。 すでにかなり時間がたってしまっておりますが、2013年9月に Sphinxをはじめよう という電子書籍をO'reilly Japan様から出版させていただきました。 もちろんSphinxで執筆しました。ここでは、その際に分かったtipsなどを共 有したいと思います。 のはずだったのですが、特別なことはなにもなく、普通にSphinxで書くだけで したので、Tipsというものはほぼありませんでした。(Sphinx後のフォント周り などでいろいろ問題があったようですが) そのため、今回はどういう体制で執筆したかについて説明したいと思います。 1. 執筆体制¶ 4人で執筆しました。 基本的に一人一章ずつ、それに加えて付録を適当に割り振って執筆していきま した。 2.
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
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で書かれていた。私は科学的な文章を書くときには絶
Sphinx ではじめるドキュメント生活 2012 #pyconjp #sphinxconjp
わかる！metadata.managedFields / Kubernetes Meetup Tokyo 48
Windowsへのインストール(スタンドアロンインストール) — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
注釈 Windows Vista以降で管理者権限が必要な場所へのインストールを行う場合は「右クリックして管理者権限で実行」してください。(管理権限は要求しないように作っています) If you need privilege to install on WIndows Vista or after, You need to install with administrator privilege (right click and choose one). これでパス設定を含めたインストールが行われます。 スタートメニューから、コマンドプロンプトを起動するか、「名前を指定して実行」で cmd と入力してみましょう。ウィンドウが表れたら、 python[Enter] とタイプします。インストールしたPythonのバージョンを表す文章に続いて、 >>> という文字が表示されればインストールは成功で
独学Linux : ゼロからはじめるSphinx《入門編》
1月11 ゼロからはじめるSphinx《入門編》 カテゴリ:Ubuntu 11.10TeX Sphinxは、HTML文書・LaTeXを用いたPDFファイル・EPUB形式の電子書籍などを同一のソースファイルから作成できるドキュメント作成プログラムです。通常のプログラムのコンパイルのように、makeコマンドを使ってそれぞれの形式の文書を作成します。 Sphinxのソースファイルは、reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で記述します。以下に、サンプルをお見せしますが、これらはすべて特別なレイアウト調整を行っておらず、デフォルトのレイアウトを使っています。このように、非常に完成度の高い多様な文書が同一のソースから作成できるというのは魅力的ですね。 以下、Ubuntu 11.10(oneiric)でSphinxを使ってみたという備忘録です。 詳細は、Sphi
SphinxでHTMLでもPDFでも見やすい文書を一発で作る
「才能を非生産的な事に浪費してこそ、真のヲタクである」 この名言にかなう為に日々色々学ぶ日々(多分)。 昨年の秋位から Sphinx を本格的に使ってきたので色々メモした事、やった事をまとめて見る。Whyの部分は後で拡充するかも。 後これは俺が買って考えた事なので、これよりいい方法とか知ってる方いたら是非に教えてください。マジで。ホントに。 尚Sphinxを使える用にして、PDFまで出力出来る様にする方法は Sphinxとrst2pdfの「domains」がないよエラー を参照してください。 ■やらないといけない事 取り敢えずやらないといけない要件は以下の通り。 HTMLはHTMLで見やすく。PDFはPDFで見やすく。 PDFは各章に通し番号を振る。HTMLは振らない。 PDFは見出し必須。しかし見出しに載せる深さは2番目まで 内容的に同一の文書を使い回す場所がある。 これに加えて、HTM
(7日目) Sphinx 拡張を作ってみよう (sphinxcontrib.nicovideo) - Hack like a rolling stone
昨日の記事ではさまざまな Sphinx 拡張を紹介しました。 その中で YouTube の動画を埋め込む Sphinx 拡張を紹介しましたが、 その中には日本の誇るおもしろ動画サービス、ニコニコ動画用の Sphinx 拡張が見当たりませんでした。 ということで、今日は sphinxcontrib.youtube に対抗して sphinxcontrib.nicovideo を作りながら、 Sphinx 拡張の作り方を紹介したいと思います。 使い方 まずは sphinxcontrib.nicovideo の使い方から紹介します。 sphinxcontrib.nicovideo は easy_install でインストールできます。 $ easy_install sphinxcontrib-nicovideo 次に conf.py で sphinxcontrib-nicovideo モジュールを
虎猫飯店 - ざれごと : #qpstudy 06 に行ってきた事。 by togakushi
前回の記事が qpstudy 05 の話か。。。最近140文字未満しか書かなくなったなｗ 今回も LT してきました。 他の人のを全部書くとスゴイことになるので割愛。 ところどころ記憶も曖昧だし。 お題は最近どっぷりハマっている Sphinx について。 「ドキュメント書くのが好きな人」って聞いてみたら誰も手を上げなくて、 「じゃあ、キライな人」って聞いたらほぼ全員が手を上げたのはビックリしたｗ 自分はドキュメント書くの好きですよ。 Sphinx で書いていいなら。 Office とかはキライですが。 何人かの方には興味持ってもらえたし、「Sphinxイイネ！」って声もたくさん聞けたので超満足。 発表資料はコチラこれも Sphinx(要テーマ拡張) で書いてます。JavaScript 有効にして見てね。 相変わらず祭りの qpstudy マジ愛してる。 そしてニフティさんマジ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
ドキュメントを作りたくなってしまう魔法のツールSphinx
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
http://atnd.org/events/25060
Charming Python: Functional programming in Python, Part 3