PHP のドキュメントを Sphinx で書いてみる (phpautodoc を作ってみた) #sphinxjp - Hack like a rolling stone
この記事は Sphinx アドベントカレンダーの 26日目(相当)を勝手に書いたものです。 Sphinx の autodoc Sphinx には autodoc という機能があります。 未だにうまく使う方法を理解できていないのですが、ちゃんと使うと Python コードに書かれた docstring を元に Sphinx 文書にリファレンスを埋め込むことができるそうです。 Javadoc や Doxygen のようなことができるということですね。 「Sphinx 文書に埋め込む」というスタイルをとっているため、 コードに記述しづらいシステムの概要やミドルウェアの話、 運用における注意点などは通常どおり Sphinx 文書として記述して、 コードに関する説明などは docstring に書くという書き分けができそうです。 ただ、あまり詳しい説明が書いていないこともあり、 また Python
VimでSphinxのプレビュー - daisuzu's notes
最近Sphinxでドキュメントを書くことがあったのでQuickRunでプレビューするhookを書いてみました。 NeoBundleでインストールしたらvimrcに次の設定をするとQuickRun時にブラウザでプレビューをしてくれます。 (要open-browser.vim) let g:quickrun_config['rst'] = { \ 'command': 'make', \ 'outputter': 'quickfix', \ 'hook/sphinx_open/enable' : 1, \ 'cmdopt': 'singlehtml', \ 'exec': '%c %o' \ } MkdPreviewでもプレビューができるみたいですが、色々とインストールしないといけないようなので試していません。。。 【おまけ】 pdf出力もしたいと思ったのですが、LaTeXやrst2pdfだと
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のバージョンを表す文章に続いて、 >>> という文字が表示されればインストールは成功で
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を作成できませんでした。 そこで発想を変
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
