Full featured documentation deployment platform
Documentation simplified Build, host, and share documentation, all with a single platform. Sign up now Easy previews and deploys Preview changes on every commit to your pull requests. Release documentation to your users on each merge. Ideal developer experience Write documentation without changing your workflow or your tools using a docs as code approach. Work privately or publicly Easily share wi
github pages に Sphinx で生成したドキュメントを公開する。 - kuma8の雑記帳
Github Pages にSphinxで生成したドキュメントを公開するほうほうです。 Github Pages では各リポジトリごとにプロジェクトページを作成することができます。 各プロジェクトごとにページを作成することでマニュアルなどの公開が便利にできます。 Sphinx で生成したドキュメントをそのまま公開すると、スタイルシートなど静的ファイルへのリンクが切れてしまいます。 静的ファイルは、ルートからのパスを想定しているためです。 html 生成時にリンクを修正してくれるプラグインが公開されています。 sphinxtogithub を利用すると、 Github Pages 用のリンクに修正してくれます。 利用方法 1. sphinxtogithub をインストールする。 $ easy_install -ZU sphinxtogithub2. conf.py で、プラグインを有効にする
ドキュメント作成ツールの検討(Sphinx、ReVIEWとか) - wadahiroの日記
今後、マニュアルを書いてメンテナンスも継続的にしていく機会が丁度ありそうなので、現時点(2012/05/02)でどのツールが自分たちにフィットするか検討してみた。ツールの候補は以下。なお、過去の仕事ではWordとDocBookは経験あり。 Word DocBook Sphinx ReVIEW 前提 今回のマニュアル作成の前提は以下の通り。 複数人で作業し、1つのドキュメントを作成する(主に章単位でアサイン)。 特定顧客向けに部分的にカスタマイズして提供することもある。 外部向けのドキュメントなので、体裁はそれなりに整っている必要がある。 製品のエディションによってマニュアル構成が変わる(上位のエディションだと機能が増えるので章や節、説明が増えるなど)。 出力フォーマットはWordまたはHTMLならOK。PDFは必須ではない。 ドキュメント中に画像はそれなりにある。スクリーンキャプチャ、構成
プレビュー機能付きMarkdownエディター·MarkPad MOONGIFT
MarkPadはWindows用のMarkdownエディターです。プレビュー機能、ブログへのアップロード機能があります。 Wiki記法のようなドキュメント記法は幾つかありますが個人的にはMarkdownが好きです。そんなMarkdown専用のWindows向けテキストエディタがMarkPadです。 起動しました。利用に際して.NET Framework 4.0が必要です。 新しいドキュメントを開きました。かなり独特なUIです。 設定画面です。拡張子の設定ができます。 ブログ設定です。書いた内容をブログにアップロードできます。 文章を書きます。Markdown形式で書くと右側にHTML変換した結果が表示されます。筆者環境では日本語が入力できませんでした。 リンクも使えます。 MarkPadは右側にプレビューが表示されるので内容の確認が容易です。そして記述した内容をMarkdownが使えるSt
reSTおよびSphinxで文章を書く際のtips - そこはかとなく書くよ。
Sphinxを使って論文っぽい文章を書くときのtipsをまとめておきます。 追記: この内容は Sphinx逆引き辞典により詳細にして載っています。 用語を書く際はreplaceを使う .. |hoge| replace:: ほげらこう定義しておくと次からは |hoge| とするだけで、ほげらと自動的に展開してくれます。つまり、あとからこの用語名を変えたいな、と思ったときにはこの定義のところだけを変えれば勝手に全部入れ替えてくれる、というわけです。 ただし、複数のrstファイルに分けている場合には使えないので、別のファイル(例えばdefinition.txt)に replace を書いておき、 .. include:: definition.txtと各rstファイルの先頭に書いておきます。この時、.rstではなく.txtなど他の拡張子のファイルに書いていることに注意してください。そうしない
Sphinxで素早く簡単に綺麗な日本語のPDFを作成する方法 - (DxD)∞
ドキュメントを書くのが楽しくなるPython製ドキュメント作成ツール「Sphinx」で簡単にPDFを作成する方法を紹介します。 Sphinxは1つのテキストファイルからHTMLやPDF、ePub等々をあっという間に生成してくれる素敵なツールです。 SphinxでPDFを生成する方法としては、「SphinxでPDFファイル作成」や「Sphinx & blockdiag Advent Calendar(全部俺) : ATND」の「(8日目) Sphinx から PDF を生成してみよう (rst2pdf 編)」「(11日目) Sphinx から PDF を生成してみよう (LaTeX 編)」で「rst2pdf」や「LaTeX」を使用する方法が紹介されているのですが、実際に試してみると周辺ツールの導入が大変だったり、エラーが出たりでなかなか思うようにPDFを作成できませんでした。 そこで発想を変
Sphinxでmscgen / graphviz | Go for it!
Sphinxでドキュメントを書いたりしています。 以前からシーケンス図やブロック図を描くのに それぞれ mscgen や graphviz といったツールを使っています。 これらのソフトウェアは、テキスト形式で定義を記述する（dot形式というらしい）と画像を生成してくれます。 単純に画像を作るだけならMicrosoft VisioやOmniGraffleでいいのですが、 テキストベースでドキュメントを書いている場合、いろんなアプリケーションを 横断しなくてはならず、ちょっと面倒なんですよね。 mscgenやgraphvizを使えばテキストファイルのみで管理することができるというわけです。 で、本題。 Sphinxにはこれらの拡張が用意されています（標準ではないです）。 拡張を導入することでSphinxドキュメント内にdot記述をすることが出来るようになります。 http://package
reStructuredText(reST)をEmacsで書く際のまとめ - YAMAGUCHI::weblog
はじめに こんにちは、非モテエンジニアです。長らくExcelで仕様書を書くのがブームらしいですが、Sphinxでドキュメントを書くと耳から脳漿垂れ流しになってしまうほど楽しくなってしまうというもっぱらの噂（俺の中で）なので、EmacsでreSTを書く際の便利機能をまとめてみました。 参照 404 Not Found 手前味噌ですが自分が関わっているSphinxの日本ユーザ会のサイトです。そもそもSphinxってなによ？Sphinx自体をどうやって導入したらいいのよ？って方はご参照ください。もちろん既にご存知の方にも最新情報含め有益な情報が満載です。 Emacs Support for reStructuredText rst.elの本家。英語ですがrst-modeについて一番詳しい説明がある場所だと思います。 rst.elの色設定 - DiaryException 色設定について詳しく説明
SphinxでPDFファイル作成
SphinxでPDFファイル作成¶ ドキュメントの成果物として、保存したり印刷したりする用途で好まれるのがPDFです。 SphinxではLaTeXを利用したPDF出力が可能です。 本ドキュメントは日本語で出力する場合についての手順を紹介します。 Sphinx で利用する TeXディストリビューション¶ Sphinx で日本語文章を書く場合は文字コードに UTF-8が利用されるため、PDF を作成する際には UTF-8 対応版の pLaTeX である必要があります。内部では ebb, mendex, platex, dvipdfmx の各コマンドを利用していますので、これらが利用できる環境を用意します。 ここでは、Windows、macOS、Linux、FreeBSDなどに対応しており、環境の作りやすさを考慮して、 TeX Live というディストリビューションを使って説明をしていきます。
Shibu's Diary: 日本語でSphinxを使う時のストレスを減らす拡張機能
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 Taken by mismisimos under CC BY-NC-SA Sphinxで日本語を書くときに、日本語の途中で改行を入れると、そこに空欄の文字が入ってしまい、ブラウザで見るときにちょっと見た目が悪くなったりします。まぁ、これはSphinxのせいというよりも、ブラウザのせいですが。 あと、Sphinxというか、docutilsは欧米の言語を対象としている仕様のため、太字にしたり、インラインマークアップを使うときには前後にスペースが必要となります。レンダリング後もこのスペースが残ってしまうため、ブラウザで見るとやはり改行と同じ悪さをします。バックスラッシュというか円記号でエスケープしたスペースを挟めばなんとかなりますが、面倒ですよね？ ということで、軽く作ってみたSp
Shibu's Diary: エキスパートPythonプログラミングできました！
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 ゴールデンウィーク後が締め切りのところ、5/6の朝4時ごろまで(清水川さんはロスタイムまで)かかって、ぎりぎりまで修正したり、少しでもいい本にしようと４人でがんばって訳したエキスパートPythonプログラミングができあがりました！訳者およびレビューアの方々には先週末に届きました。正式に本に並ぶのは5/31の予定です。なお、アマゾンだと5/28になっているので、大型書店では今週にでも買えるのかも。 目次などを含む、日本語版の情報のポータル的サイトと、そのはてブ by 共訳者の清水川さん 「エキスパートPythonプログラミング」を翻訳しました(DSAS開発者の部屋) by 共訳者の稲田さん エキスパートPythonプログラミングのサンプルが届いた！(清水川記) by 清水川さん
Sphinxを使用している日本語のサイト - murapong's blog
ドキュメンテーションツールのSphinxを使用している日本語のサイトを調査する機会があったのでまとめておきます。 タイトル URL Sphinx ドキュメント http://sphinx.shibu.jp/index.html TortoiseHg マニュアル http://tortoisehg.bitbucket.org/manual/0.9-ja/index.html Django ドキュメント http://djangoproject.jp/doc/ja/1.0/index.html Zope 2 関連ドキュメントと記事 http://docs.zope.jp/zope2/ Kay ドキュメント http://kay-docs-jp.shehas.net/ django-bpmobile ドキュメント http://docs.nullpobug.com/bpmobile/trunk/
OMakeでSphinxを自動継続ビルドしてみよう
題名通りです。Sphinxっていうドキュメント作成ツールがあって、これがなかなか簡単に作れる、かつ様々なフォーマットの書き出しに対応してるのですごく使いやすい。 Sphinxについて詳しく知りたい方は以下のURLを参照すればいいような気がします。 Pythonって何？という人のためのSphinxインストール入門 しかしSphinxには自動でプロジェクトのMakefileが生成されるので簡単にビルドできるようになっているんですけど、それでもhtmlファイルをrstファイルが変更される度に自動ビルドしてくれたらもっと便利になるのにとか思うのが人の常。 というわけで、前回の記事と絡めて、OMakeでSphinxを自動継続ビルドしてみようというのが今回の記事の目的です。 まずはOMakeのインストールからまず、OMakeっていうのはGNU/BSDのmakeもどきみたいなソフトです。でも「もどき」っ
Shibu's Diary: Sphinx紹介セッション@BPStudy #30
渋日記@shibu.jp 渋川よしきの日記です。ソフトウェア開発とか、ライフハックを中心に記事を書いていきます。 BPStudy #30に登壇してきました。ネタはSphinxの紹介です。資料はこちらにあります。Slideshareに上げてみたけど、固定長フォントが崩れて、ソースコードがうまく表示されないという、チュートリアルのテキストとしては大問題な感じだったので、ドキュメントがアップできるようになったというGoogle Docsを利用しました。いいですね、これ。Slideshareみたいに、ビュー数とか、ソーシャル機能がないのはちょっと寂しいけどね。 結果としては、Sphinxの良さを伝えることができたかな、と思っています。すごく反応して拡張機能に手を染め始めた人もいるし、僕自身も、Sphinxを紹介する武器として、今回スライドを作ることができたので、今後はいろんなところで生かして行きた
Overview — Sphinx v1.0 (hg) documentation
ダウンロード このドキュメントはバージョン1.0 (hg)のためのものです。まだリリースされていません。 Mercurialリポジトリのコードを利用するか、Python Package Indexにあるリリースバージョンを探してください。 疑問? 意見? Googleグループへの参加: もしくは、FreeNodeの#python-docsチャンネルへどうぞ 何か気づいたことがあれば、issue trackerを使用して通知することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。そして、今までに数々のPythonや、他の言語で開発されているプロジェクトに対して、すばらしいドキュメンテーシ
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
[20110129] sphinx theme collection 2011春![[20110129] sphinx theme collection 2011春](https://cdn-ak-scissors.b.st-hatena.com/image/square/c885499575c3f5fb3e424ba60c903e1efde79ec4/height=288;version=1;width=512/https%3A%2F%2Fcdn.slidesharecdn.com%2Fss_thumbnails%2F20110129sphinxthemecollection2011-110130080033-phpapp01-thumbnail.jpg%3Fwidth%3D640%26height%3D640%26fit%3Dbounds)
逆引き辞典
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
restructuredtext用のエディタを作ってみた - 偏った言語信者の垂れ流し