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
javasphinx User’s Guide — javasphinx 0.9.8 documentation
Configuration¶ To enable javasphinx for your existing Sphinx configuration add 'javasphinx' to the list of extensions in your conf.py file. javasphinx can be configured to cross link to external sources of documentation using the javadoc_url_map option, javadoc_url_map = { 'com.netflix.curator' : ('http://netflix.github.com/curator/doc', 'javadoc'), 'org.springframework' : ('http://static.springso
Sphinx で自動的にAPIリファレンスを作成したい - Study08.net 対シンバシ殲滅用人型機動兵器
今日はこのネタです。タイトルの通りなんですが、PythonでそもそもAPIリファレンス的なドキュメントをどうやって作ったら良いのか知りませんでした。 他の言語であれば下記のようなツールを過去に使った事がありました。 Java なら Javadoc Perl なら pod2html PHP なら PHPDocumentor (今ならもっと賢いツールありそうだけど。。。) Pythonなら? ではPythonであればどのような選択肢があるでしょう。調べた限りではまず下記のような選択肢がありました。 pydoc -w でHTML生成 (pydocで簡単なPythonファイルのドキュメントを作成する) Epydocを利用する (Epydoc - 偏った言語信者の垂れ流し) javadocやらphpdocmentorやらのように、まるっとソースからHTMLを生成するだけであれば、これで十分かもしれま
Sphinxのドキュメントサンプル：業務利用例
Sphinxのドキュメントサンプル：業務利用例¶ 日本UNIXユーザ会 2010年12月勉強会 (2010/12/3) の発表で使用したドキュメントを作りたくなってしまう魔法のツール Sphinx のデモで使用したドキュメントのひな形です。プレゼンテーションの全文はドキュメントを作りたくなってしまう魔法のツール Sphinx にあります。 デモで使用したSphinxのドキュメントサンプルを以下のリンクからダウンロード出来ます。 Step2:ドキュメントの例(Sphinxデータ) 2portfolio.zip Step2:ドキュメントの例(HTML) Step1 Sphinxの初期ドキュメントから始める¶ 初期ドキュメントから始めると言っても、 sphinx-quickstart コマンドで作成しただけの状態のファイルを共有しても、それではドキュメントを書いてくれないでしょう。これは「どう書
watchdogモジュールのwatchmedoコマンドが便利 - 偏った言語信者の垂れ流し
誰から教えてもらったのか忘れたけど、ファイルの変更を監視して何か処理を行ったりできるwatchdogというPythonモジュールを試してみたら良い感じだった。 http://pypi.python.org/pypi/watchdog インストール PyPIに登録されているのでeasy_installでインストールできる。 > easy_install watchdog watchmedoコマンドの使い方 watchdogをインストールするとwatchmedoというコマンドが使える。 watchmedoコマンドは、ファイルの変更があった際にコマンドを実行したりすることができる。試した環境はWindowsXP。 例えばカレントディレクトリ以下の拡張子がrstのファイルの変更があった場合に、Sphinxのmake htmlを実行するならこんな感じ。 > watchmedo shell-comma
Paver: ソフトウェアプロジェクトのための簡易スクリプティング — Paver v1.0.1 documentation
Paver: ソフトウェアプロジェクトのための簡易スクリプティング¶ Paver は Make や Rake によく似た Python ベースのソフトウェアプロジェクトのスクリプティングツールです。例えば C 言語のプログラムのように必要な依存関係を追跡して扱うようには設計されていません。Python 構文と豊富なライブラリコードの利便性により、雑多な全ての繰り返しタスク(ドキュメントを生成する、関連ファイルを移動する、ダウンロードする)に対して 補助するように 設計されています 。 もしあなたが Python でアプリケーションを開発しているなら、なおさら使用してみましょう。大半の Python のパブリックプロジェクトは再配布向けのソース tarball を作成するために distutils か setuptools を使用します(プライベートプロジェクトもこの利点を得ることができる！
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
Sphinx-Users.jp¶ Sphinx-Users.jp(略称#sphinxjp)は、美しいドキュメントを簡単に生成することができるドキュメンテーションツール、 Sphinx （スフィンクス）の普及を主眼としたコミュニティです。SphinxはPythonの公式ドキュメントだけでなく、このSphinx-Users.jpのサイトも含め多くのマニュアルやサイトで使用されており、詳細を Sphinxの歴史で紹介しています。 Sphinx-Users.jp は日本の Sphinx コミュニティです。 Sphinx-Users.jp では、日本で散らばっているSphinx関連情報を集めて、Webサイト、イベントを通じてSphinx情報を発信します。 slack のコミュニケーションや勉強会の開催などを通じて、ドキュメントをパワーアップしたい人、ドキュメントや翻訳で苦労している人、Sphinxの
2012.05版 Python開発のお気に入り構成（ポロリもあるよ） - YAMAGUCHI::weblog
はじめに こんにちは、Python界の情弱です。最近は色々とPythonの開発環境も変化してきていて、ようやくPython2.xとPython3.xを行き来しながら開発する体制が整ってきたという印象を受けています。ここしばらくは色々と試していたのですが、ようやく鉄板っぽい方法にたどり着いたのでメモしておきます。 なお、後半はPythonに限らない内容なので、他のLLを使っていても使えそうかなと思っています。この環境を設定すると何ができるのかというと、以下のことすべてが、無料で、自鯖を立てることなく行えます。 開発環境の整理（virtualenv） ローカルでの複数環境のテスト容易化（tox+pytest） CIによるテスト（Travis-CI） ドキュメントの自動ビルドおよびドキュメントの公開（ReadTheDocs） 概要 とりあえず全体像を先に共有しておきます。ちょっとでかいですがご了
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
src から rst 生成 - Python Advent Calender 2013 11日目 — SXIMADA W3
ドキュメントを作りたくなってしまう魔法のツールSphinx
redirecter