ドキュメントを作りたくなってしまう魔法のツール「Sphinx」Who is the person whom the IT engineers should learn next to Alexander?Yoshiki Shibukawa
執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
Sphinx再入門（Sphinx+翻訳 Hack-a-thonにて） - Edo::Blog
Sphinx+翻訳 Hack-a-thon 2015.01 - connpass 参加時に書いたエントリーです。 参加のきっかけ Sphinxは1年前くらいに触ってみたものの、その後、利用機会がなく使い方を忘れてしまう... 今回再チャレンジを検討してみるも、再度挫折しそうな気もするので、本イベントを利用させてもらって集中的に取り組もうと考えた。 ※ イベント名にはハッカソンってなっているけど、参加対象／趣旨は下記の通りで参加しても問題なさそう（問題なかった） 主に以下の方を対象にしています。 Sphinx で文章を書きたい/書いている人 ドキュメントの執筆/翻訳をしている人 ( Sphinx を使ってなくても ok ) Sphinx のハック(改良、拡張づくり、テーマづくりなど)をしている人 Sphinx に興味がある/使ってみたい人 その他ドキュメントに関する素敵ななにか (all t
Sphinxをはじめよう
本書には改訂版があります。 Officeツールを使用していて、思うようにならずストレスを感じる事はありませんか？あるいは、印刷用の資料を見ている時に、Webブラウザで閲覧しやすいフォーマットになっていて欲しいと思ったりはしませんか？ 本書はPythonで標準的なドキュメント作成ツールとして利用されているSphinxの入門書です。Windows、OS X、Linux（Ubuntu）を例に、Sphinxの概要からインストール、基本的な利用法について。またSphinxからLaTeXを経由してPDFを作成したり、EPUBフォーマットの電子書籍を作成する方法を、初めて触れる方にもわかりやすく紹介しています。 なお本書はEbook版のみの販売となります。 はじめに 本書を読むにあたって必要な環境とバージョン 本書が想定する読者 本書で使用されている表記規則 サンプルコードの使用について 本書に関するお
Jenkinsを使ったSphinxとS3によるドキュメントサイト構築 | DevelopersIO
渡辺です。 開発者の間ではgithub式Markdownでドキュメントを書くのが主流となっている昨今ですが、エンドユーザ向けのドキュメントとなると出力フォーマット・版管理・クロスリファレンスなど、機能的にもう少し欲しいところです。しかし、Wordといった専用の文書作成ソフトを使うほどでもないし、表計算ソフトを使うのは論外だと思われます。 そんな要求を満たすツールはSphinxです。今回は、Sphinxを利用してドキュメントを生成し、Jenkinsによる自動ビルドでHTML形式のファイルを作成し、S3へのリリースする手順を解説してみます。Sphinxは静的ファイルを生成するため、S3やCloudFrontと相性良く利用できるソリューションです。 Sphinxとは？ Sphinxは、ドキュメント生成ツールです。SphinxではPythonで採用されているreStructuredText(reS
SphinxをMarkdownで使い隊
Sphinxを、MercurialとPandocを組み合わせて Markdown記法で運用できるようにしたお話。
Sphinx本の執筆体制について — そこはかとなく書くよん。 ドキュメント
Sphinx本の執筆体制について¶ この記事は ドキュメンテーション Advent Calendar 2013 の4日目の記事です。 すでにかなり時間がたってしまっておりますが、2013年9月に Sphinxをはじめよう という電子書籍をO'reilly Japan様から出版させていただきました。 もちろんSphinxで執筆しました。ここでは、その際に分かったtipsなどを共 有したいと思います。 のはずだったのですが、特別なことはなにもなく、普通にSphinxで書くだけで したので、Tipsというものはほぼありませんでした。(Sphinx後のフォント周り などでいろいろ問題があったようですが) そのため、今回はどういう体制で執筆したかについて説明したいと思います。 1. 執筆体制¶ 4人で執筆しました。 基本的に一人一章ずつ、それに加えて付録を適当に割り振って執筆していきま した。 2.
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
Sphinx Advent Calendar 2012 (2012/12/01 00:00〜)
sphinxに関わる内容ならどんな内容でも構いません。ゆるい感じでいきましょう。ネタがかぶってもOK、使い回しもOK、気にしない！
独学Linux : ゼロからはじめるSphinx《入門編》
1月11 ゼロからはじめるSphinx《入門編》 カテゴリ:Ubuntu 11.10TeX Sphinxは、HTML文書・LaTeXを用いたPDFファイル・EPUB形式の電子書籍などを同一のソースファイルから作成できるドキュメント作成プログラムです。通常のプログラムのコンパイルのように、makeコマンドを使ってそれぞれの形式の文書を作成します。 Sphinxのソースファイルは、reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で記述します。以下に、サンプルをお見せしますが、これらはすべて特別なレイアウト調整を行っておらず、デフォルトのレイアウトを使っています。このように、非常に完成度の高い多様な文書が同一のソースから作成できるというのは魅力的ですね。 以下、Ubuntu 11.10(oneiric)でSphinxを使ってみたという備忘録です。 詳細は、Sphi
設計ドキュメント作成ツールとしてSphinxとReVIEWについて調べた - 勘と経験と読経
主に作業メモ。ソフトウェア開発プロジェクトでは多かれ少なかれ様々なドキュメントを作成する。一般的にはMicrosoft OfficeなどのOAソフト(つまりWordやExcel)で文書を作成するのだけれども、これが非常に管理し難い。本当はWikiなどで管理するのがいいのだけれども、「納品」とか「持ち出し」を考えたときに、Wikiサーバを立てるのはあまりうまくない。というわけで以前に少しだけチェックしていたドキュメント作成ツールについて改めて調べてみた。 Sphinx Python製のドキュメント生成ツールである。reStructuredText記法という文法で記述したテキストツールをCUIでコンパイルすると、HTMLやPDFなどの各種ドキュメントを生成してくれる。 インストールは非常に容易 (Windowsだが、他のOSでも簡単なのだと思う) reStructuredText記法は、Wik
Shibu's Diary: Pythonって何？という人のためのSphinxインストール入門
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 この前のブログのエントリーにも書きましたが、Sphinxというステキすぎるツールがあります。ドキュメントがどんどん書きたくなっちゃうステキなツールです。ですが、残念ながら、使用するためにはインストールする必要があります。Pythonって何？という人には少々敷居が高いため、解説の記事を書いてみました。 [STEP 1] Pythonからインストールする場合 WindowsではPythonからインストールする必要があります。一発でインストールできる環境を持っている人は最後の方のインストール法に飛んでください。また、Mac OS Xみたいに、最初からPythonから入っている人は[STEP 1]は飛ばしてください。 Windwsの場合 http://python.orgを開きます。P
ドキュメンテーションを加速するストレスフリーの作図ツール『blockdiag』 jus2011年6月勉強会
システム開発や保守、運用の現場においてドキュメントは必須のものです。 しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュ メントが存在しない、資料が古いままになっているなどといった現状を多く 耳にします。 本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、 みるみるうちに図を作成できる「blockdiag」をご紹介します。 「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの 画像ファイルを出力可能なオープンソースの画像生成ツールです。書き やすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに 配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちら このような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成 するツール「Sphinx」を組み合わせることによって
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinxの全文検索を複合語に強くする
https://sphinx-users.jp/doc10/tutorial.html