SphinxでHTMLでもPDFでも見やすい文書を一発で作る
「才能を非生産的な事に浪費してこそ、真のヲタクである」 この名言にかなう為に日々色々学ぶ日々(多分)。 昨年の秋位から Sphinx を本格的に使ってきたので色々メモした事、やった事をまとめて見る。Whyの部分は後で拡充するかも。 後これは俺が買って考えた事なので、これよりいい方法とか知ってる方いたら是非に教えてください。マジで。ホントに。 尚Sphinxを使える用にして、PDFまで出力出来る様にする方法は Sphinxとrst2pdfの「domains」がないよエラー を参照してください。 ■やらないといけない事 取り敢えずやらないといけない要件は以下の通り。 HTMLはHTMLで見やすく。PDFはPDFで見やすく。 PDFは各章に通し番号を振る。HTMLは振らない。 PDFは見出し必須。しかし見出しに載せる深さは2番目まで 内容的に同一の文書を使い回す場所がある。 これに加えて、HTM
Baker Tech Note
最近、公私ともにプロジェクト管理にredmineを使うことが増えてきた。 redmineは、便利なツールだが気になるのが、記述に使っているtextile記法。以前は、tracやpukiWikiを使っていたこともあり、なにかツールを替える都度に新しい記法を覚えるは面倒くさい。ましてや、最近はプログラムでhtmlタグを書くのも色々と簡易的な記法が増えてきて、それはそれで便利だがちょっと、もう少し統一してもらっても良いような気がする。 また、昔からExcelやdocでドキュメントを作ることも嫌いだった。やむを得ず作る時もあるのだが、普段使いではない。textで書いて置けば検索が楽だし、ポータビリティも良いではないか。 なにが、言いたいのか。つまり、一つの記法で全てに対応出来ないだろうかと言うことだ。 表:アプリケーション毎に異なる記法 | case | style | |----------|-
Sphinxの魔法にかかってみた - ふぞろいのGENGOたち
はじめに 最近ドキュメントの整備が最優先重要課題になってきたので、ドキュメントを効率よく書くための方法を調査していました。 年初くらいから調査していて、 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」 とか 「遷移図生成ツール blockdiagの紹介]」 とか 「本当のドキュメントと向き合えますか」 を見て ようやく「Sphinxにしよう！」と決心したので、Windows環境にSphinxを導入してみました。 そこで、この記事ではWindows環境にSphinxを導入するための手順を紹介したいと思います。 記事の作成にあたって、次のサイトを参考にさせていただきました。 「blockdiag を WindowsXP で動かす」 「OmakeでSphinxを自動継続ビルドしてみよう」 目標 この記事では、次のことが実現できる環境を構築します。 Sphinxを使って、テキスト
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
はやわかり reStructuredText
本マークアップ記法の完全な詳細は reStructuredText のページに示されています。このテキストは、覚書としての性格の文書です。 "(詳細)" というリンクを辿ると reStructuredText 仕様書を参照できます。 ただし、相対リンクとなっていますので、リンク切れの場合は、 原版の "Quick reStructuredText" から参照してください。 目次 インライン マークアップ バックスラッシュによるエスケープ 章立ての構造 段落 記号つきリスト 番号つきリスト 定義リスト フィールドリスト オプションリスト 整形済みブロック ラインブロック 引用 Doctestブロック 表 区切り線 明示的マークアップ 脚注 出典 リンクターゲット 外部ターゲット 内部ターゲット 間接ターゲット 暗黙ターゲット ディレクティブ 代入参照とその定義 コメント 助けを得たい場合は
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
逆引き辞典
