Sphinx と LiveReload を組み合わせる
こちらの記事の Python 版です。 Sphinxの更新をguard-livereloadで検知してブラウザを自動リロードする sphinxでドキュメントを書く際に生じる「文章の記述 => ビルド => ブラウザでの確認」 という一連のサイクルを人力でやるのは効率が悪い。 いろいろな省力化対策が考えられるが、ここでは guard-livereloadを使って、 文章のビルドとブラウザのリロードを自動化する方法を説明する。 目次 環境構築 Guardfile を用意する 実行してみる 終わりに 環境構築 livereload の仕組みを Python で実装したパッケージがありますので、これを使います。 Tornado をベースにしていますので、なんとなく相性が良さそうですね。 Python LiveReload - Package Python LiveReload - Document
SphinxでHTMLでもPDFでも見やすい文書を一発で作る
「才能を非生産的な事に浪費してこそ、真のヲタクである」 この名言にかなう為に日々色々学ぶ日々(多分)。 昨年の秋位から Sphinx を本格的に使ってきたので色々メモした事、やった事をまとめて見る。Whyの部分は後で拡充するかも。 後これは俺が買って考えた事なので、これよりいい方法とか知ってる方いたら是非に教えてください。マジで。ホントに。 尚Sphinxを使える用にして、PDFまで出力出来る様にする方法は Sphinxとrst2pdfの「domains」がないよエラー を参照してください。 ■やらないといけない事 取り敢えずやらないといけない要件は以下の通り。 HTMLはHTMLで見やすく。PDFはPDFで見やすく。 PDFは各章に通し番号を振る。HTMLは振らない。 PDFは見出し必須。しかし見出しに載せる深さは2番目まで 内容的に同一の文書を使い回す場所がある。 これに加えて、HTM
Windows で Sphinx を使ってみるよ（その後） - うっかりアジャイルの推進側に回っちゃった人の日記
rst2pdf がアップデートされました！ （ ver 0.16 ) easy_install --upgrade rst2pdf make pdf font が見つからないとエラーが。 pdf_font_path 大文字小文字を区別するっぽい？ conf.py を修正。 pdf_font_path = ['C:\Windows\Fonts'] 再度挑戦。 meiryo が見つからないエラーはない。 けど、以下のエラーが延々と出力されて、処理が終わらない。 [ERROR] findfonts.py:248 Unknown font: DejaVu Sans Mono-Oblique rst2pdf なら問題ないのに。何が違うんだろう？ DejaVu Sans-Oblique がないのが問題か？ フォントはスタイルで指定するので、 conf.py のスタイルの設定を疑ってみる。 pdf_st
Sphinx + TeX + PDF with jsbook - 検討!目論見委員会Z
あけましておめでとうございます*1。千葉です。 前回の記事を書いたところ、「Sphinxで薄い本を書いてみた」人がいた！という記事を uchida さんが書いてくださいました。 Sphinxで薄い本を書いてみた - 検討!目論見委員会Z tboffice.hatenablog.jp/entry/2012/12/… という記事が読んで触発されて gist 書きました #sphinxjp gist.github.com/4385759— Akihiro Uchida (@auchida) December 27, 2012 その返信としてこのエントリを上げます。 ちなみに uchida さんはどこかでお見かけしたことがあるなと思ったら、Sphinxへ日本語PDFパッチを作られた方ではないですか…びっくりしました。 LaTeX経由でのPDF作成 発端 SphinxからTeX経由でPDFを作る過程
Private Presentation
Private content!This content has been marked as private by the uploader.
使い始めたばかりのSphinxでPDFを生成してみた | kanonjiのブログ
MacにSphinxをインストールしたメモ | kanonjiのブログで使い始めたSphinxで、やってみたかったPDF生成を試して気がついた事をメモします。 プロジェクトを作る :: ドキュメンテーションツール スフィンクス Sphinx-users.jpからSphinxでPDFファイル作成 :: ドキュメンテーションツール スフィンクス Sphinx-users.jpを参考にしました。 index.rstはスペース3個 Contents: .. toctree:: :maxdepth: 2 expert_python art_of_community http://sphinx-users.jp/gettingstarted/make_project.html#id2 いきなりはまったのがインデントのサイズ。index.rstに目次というかTOCを書いて、そこに書いたファイルがビルド対
独学Linux : ゼロからはじめるSphinx《入門編》
1月11 ゼロからはじめるSphinx《入門編》 カテゴリ:Ubuntu 11.10TeX Sphinxは、HTML文書・LaTeXを用いたPDFファイル・EPUB形式の電子書籍などを同一のソースファイルから作成できるドキュメント作成プログラムです。通常のプログラムのコンパイルのように、makeコマンドを使ってそれぞれの形式の文書を作成します。 Sphinxのソースファイルは、reStructuredText（拡張子は .rst）と呼ばれるマークアップ言語で記述します。以下に、サンプルをお見せしますが、これらはすべて特別なレイアウト調整を行っておらず、デフォルトのレイアウトを使っています。このように、非常に完成度の高い多様な文書が同一のソースから作成できるというのは魅力的ですね。 以下、Ubuntu 11.10(oneiric)でSphinxを使ってみたという備忘録です。 詳細は、Sphi
Sphinxでのドキュメント作成をそれなりに快適に書く方法 - /dev/null
前回書いた通り、ドキュメント作成にSphinxを使い始めています。 Markdownと違って単一のページを書くのはちょっと大仰な感じしますが、体系的なドキュメント書くのには構造がしっかりしている分いい感じ。 ところがMarkdownと違って書いてプレビューしたいなと思う度に make html するのは辛い。しかもその後ブラウザで開く必要あり。開いていてもリロード。 これではSphinx始めたてで、文法と文書がリンクできない人間にはちょっとつらい。 前回、コマンド一発でhtmlが吐かれるところまではできています。 SublimeText2でSphinx-Build - /dev/null これはあんまり苦じゃありません。そこまでbuildが遅いわけでもないので。大体1秒もあれば終わる。 あとはこれを自動でプレビューし変更を感知してリロードしてくれればそれなりに書ける環境が出来上がるのではな
「Sphinxをはじめよう」を読んで導入したいと思ったので色々考えてみた2 - kk_Atakaの日記
前回のあらすじ 「Sphinxをはじめよう」を読んで導入したいと思ったので色々考えてみた - kk_Atakaの日記 かなり期間があいてしまったが、次に考えるは、実際にどうやって「導入」して「運用」するか。 「納品」するに当たってどんな問題があるか。 このあたり、良い前例があったら知りたいところ。 課題 課題はとりあえず2段階あると思っている。 第1段階: 対開発工程の課題 プロジェクトに対しての導入・運用方法 どうやって運用していくか。 ルール決め大事。 第2段階: 対納品工程の課題 納品形式 納品後修正が発生した場合どうするか 顧客(※)に対してどうやって納品するか、またそれをなおすのは誰？ (※) 顧客とは、納品したドキュメントを読む、使う、なおす人。社内の人かもしれないし、社外の人かもしれない。 一つずつ考えていく。 対開発工程 登場人物 以下、架空の登場人物とする。 リーダー :
業務での利用事例
業務での利用事例¶ 対象 ソフトウェア開発プロジェクト 規模:1名~10名前後 ドキュメント、書いていますか？¶ 想像してみてください。 この規模、たとえば1名のプロジェクトだとしたらどれくらいドキュメントを書くでしょうか？あるいは10名だったとしたら、どんな役割分担でドキュメントを書くでしょう。 そもそも、彼らはいつドキュメントを書くでしょうか。プロジェクトの方針がある場合、無い場合、色々なケースがあると思いますが、ドキュメントを作る事に対してかれらはどんなことを考えるでしょう。 ドキュメントを書いている割合¶ 業務のプロジェクトには大規模なものから小規模なものまでたくさんありますが、その数に対する「ドキュメントを書いている」比率は意外と低いのではないかと思います。前任者や別の部署・会社から引き継いだプロジェクトにまともなドキュメントがほとんどなかった経験がある方もいるのではないでしょう
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
rst2pdf - Google Code
https://hnakamur.github.io/sphinx-rst2pdf-plantuml-japanese-example/sphinxrst2pdfexample.pdf
How to use rst2pdf
http://rst2pdf.googlecode.com/svn/trunk/doc/manual.txt
https://www.nic.ad.jp/ja/materials/iw/2011/proceedings/t3/t3-04.pdf
GitHub - hsk81/notex-v2.0: A text editor for reStructuredText, Markdown, LaTex and more!