Sphinxjp.themes.s6 を使ってプレゼンする — docs v0.1 documentation公式¶ Python Package Index : sphinxjp.themes.s6 Output Sample を見ると動きはなんとなくつかめると思うので、ソースと比較しながら眺めましょう
(6日目) Sphinx 拡張の紹介 - Hack like a rolling stone
Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
Windows環境でSphinxを使って日本語PDFを作成するメモ - 記憶は削除の方向で
参考URL http://sphinx-users.jp/gettingstarted/install_windows.html http://sphinx-users.jp/cookbook/pdf/rst2pdf.html 前提条件 easy_installで依存ライブラリもインストールされるはず。今回試したのは以下のバージョン。 python 2.6.6 docutils 0.7 jinja 2.5.2 PIL 1.1.7 pygments 1.3.1 reportlab 2.5 rst2pdf 0.16 sphinx 1.0.4 ディレクトリ構成はこんな感じ WORK_DIR +-build ・・・ 成果物格納ディレクトリ +-fonts ・・・ フォント格納ディレクトリ +-souce ・・・ ソース格納ディレクトリ +- index.rst ・・・ ソース +- conf.py
Sphinxのバージョンアップ（Windows） - torutkのブログ
以前WindowsマシンにセットアップしたSphinxのバージョンアップメモです。 Sphinxでドキュメント生成（Windowsでの始め方） - torutkの日記 Sphinxでドキュメント生成-図を描く（Windowsでの始め方） - torutkの日記 Sphinxは、Pythonのモジュールとして作られています。インストールには、setup.py を使いましたが、バージョンアップに際して削除といった機能はないようです。 そこで、いったん前のバージョンを削除し、新しいバージョンをインストールするという操作を行います。 古いバージョンのアンインストール方法 setup.py でインストールした場合 Pythonのsite-packageディレクトリから削除する eggを使ってインストールした場合 site-packageディレクトリにある<モジュール名>-<バージョン>-.eggディ
Sphinxでドキュメント生成-PDF（Windowsでの始め方）（続） - torutkのブログ
昨日の日記の続きです。 Sphinxでドキュメント生成-PDF（Windowsでの始め方） - torutkの日記 Sphinxで、PDFを生成（rst2pdf）するためには、ドキュメント・プロジェクトをquickstartで作成する毎に、conf.pyの修正、make.batの修正、ja.jsonのコピーをする必要があります。ちょっと面倒ですね。 そこで、quickstartでプロジェクトを作成するときに、デフォルトでPDFの設定を入れられるよういじってみました。 sphinx-quickstartで実行される処理はquickstart.py Sphinxをインストールすると、以下のディレクトリにSphinxのスクリプトが置かれます。 \Lib\site-packages\Sphinx-1.0.7-py2.6.egg/sphinx/ quickstart.py そこで、このquickst
Sphinxでドキュメント生成-PDF（Windowsでの始め方） - torutkのブログ
昨日の日記の続きです。 Sphinxでドキュメント生成（Windowsでの始め方） - torutkの日記 今日は、SphinxでPDF形式のドキュメント生成を行います。PDF形式に出力するには、TeX経由で行う方法とSphinxのrst2pdf拡張で行う方法があるようです。 SphinxでPDFファイル作成 — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会(Sphinx日本ユーザー会ドキュメントより） 上記ドキュメントの比較によると、rst2pdfがよさそうなので、これを使ってPDF出力の仕組みをWindowsに整えます。なお、昨日同様、インターネットに接続していないPCでも環境を整えられるよう、必要なものをダウンロードしインストールします。 Windows上でrst2pdfを用意する PythonのReportLab Toolkitモジュール rst2pdfが
Sphinxでドキュメント生成（Windowsでの始め方） - torutkのブログ
プログラミング関連でドキュメントを作成する場合、章節構成を持つ文章を書き、随所に箇条書き、図表、ソースコードや画面をちりばめることが多いです。また、文書の書式は、HTMLやPDFなど複数の形式で出せると便利です。 Smartdoc、docbookが候補に挙がりますが、両者ともXML文書形式で記述するので、ソース文書作成が慣れないと手間ですし、慣れてもXMLタグ混じりの文章は見やすいものではありません。 Wikiは、ドキュメントを配布する、というときには不向きですし、文書作成がブラウザ上、というのも苦痛です。また、Wikiのサーバーがないところで原稿作成もできません。 そんなとき、Sphinxと呼ばれるツールの存在を知りました。 http://sphinx-users.jp/ ざっと見ると、reStructuredTextと呼ばれるテキスト形式で文書を記述し、コマンドでHTMLを生成するもの
Overview — Sphinx v1.0.6 documentation
A project Download 現在のバージョン: 1.4.4 Python Package Indexからソースコードをダウロードするか、以下のコマンドでインストールしてください: pip install -U Sphinx 疑問? 意見? Googleグループのsphinx-users グループへの参加 もしくは、FreeNodeの#sphinx-docチャンネルへどうぞ。 何か気づいたことがあれば、issue trackerを使用して報告することもできます。 Sphinxは知的で美しいドキュメントを簡単に作れるようにするツールです。Georg Brandlによって開発され、BSDライセンスのもとで公開されています。 このツールはもともと、新しいPythonのドキュメントの変換のために作られました。Pythonのプロジェクトのためのすばらしい機能を提供してきましたが、現在ではC/
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
oceanmarine.org