PythonプロジェクトのドキュメントをSphinxで作成する - Qiita
Pythonのプロジェクトでドキュメントを書く、といったらSphinx、というくらいSphinxはメジャーなツールになっています。そのため、ここではPythonのプロジェクトドキュメントをSphinxで作成する手順について解説します。 Sphinxのインストール Sphinxについては、日本ユーザー会のサイトで詳しく解説されています。当然、インストールの手順も記載されています。 Sphinx-Users.jp 上記の解説ではeasy_installを使用していますが、pip install Sphinxや、Anaconda/Minicondaを使っていればconda install Sphinxでも導入可能です。 ※2015/8/2現在、Sphinxが依存するBabelの最新版2.0ではPython3環境において不具合があります。これを回避するには、一旦pip uninstall babe
忙しい研究者のためのテストコードとドキュメントの書き方 - Qiita
はじめに 「研究用のプログラムにもテストコードやドキュメント書いたほうがいいよね。」 「分かっちゃいるけど、そんな面倒なことやってられないよ。」 という研究者あるあるを解決すべく、僕が普段実践している開発スタイルを紹介します。 この開発スタイルのすごいところは： テストやドキュメントを一切書かない場合と比べて 追加の工数がほぼゼロ。 普通にコーディングしているだけで、いつのまにかテストコードとドキュメントまでできあがっている。 実装、コメント、テスト、ドキュメントが自然に同期するので、保守しやすい。 Pythonを例に紹介しますが、コメント内にテストを書けるツールと、コメントからドキュメントを生成できるツールをもつ言語ならばどれにでも応用できるはずです。 この開発スタイルに至った背景 ソフトウェア開発において、テストコードやドキュメントを整備することでプログラムの品質が向上することは広く知
自分自身のポートフォリオを構築する
警告 この記事は古い為 easy_install の使用等、現在では非推奨の説明があります。インストール周りについては Windowsへのインストールの手順を参照してください。 これまでの説明で紹介してきたテンプレートは、あなたのソフトウェアのドキュメント作成に使用することができる基盤となります。ここからは、Pasterを使用して、自分自身のドキュメントのポートフォリオを構築するために、それ以外のテンプレートを追加するための方法を紹介していきます。 プロジェクト中に作成するドキュメントの量に関しては、必要最低限で、十分というのを心がけてください。追加されるそれぞれのドキュメントについても、対象となる読者を明確に定義し、実際のニーズを満たすようにします。実際に価値の増加に寄与しないドキュメントは書くべきではありません。 ドキュメントのランドスケープの構築¶ 前節で説明をしてきたドキュメントポ
sphinx.ext.napoleon – NumPy および Google スタイルの docstring をドキュメントに取り込む — Sphinx 1.5.6 ドキュメント
Napoleon - Marching toward legible docstrings¶ 以下のようなdocstringを書こうとしてみたことはあるでしょうか。 :param path: The path of the file to wrap :type path: str :param field_storage: The :class:`FileStorage` instance to wrap :type field_storage: FileStorage :param temporary: Whether or not to delete the file when the File instance is destructed :type temporary: bool :returns: A buffered writable file descriptor :rtyp
概要 — Sphinx 1.4.4 ドキュメント
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/
日本UNIXユーザ会 2010年12月勉強会 (2010/12/3)
日本UNIXユーザ会 2010年12月勉強会 (2010/12/3)¶ 日本UNIXユーザ会の2010年12月の勉強会にて、以下の内容で発表させていただきました。(本ページ末尾から当日資料を閲覧出来ます) 「ドキュメントを作りたくなってしまう魔法のツール Sphinx」¶ 日時: 2010/12/3(金) 18:30～20:30 (受付開始 18:10) 場所: すみだ産業会館 第一会議室 (錦糸町駅前墨田区・丸井共同開発ビル9階) 講師: 渋川よしき、山口能迪、清水川貴之 詳細: 日本UNIXユーザ会 2010年12月勉強会ページをご確認下さい 発表の様子¶ 内容:¶ システム開発や運用現場にドキュメントはつきものです。しかし、作り方がわからない、作る時間が取れないなど悩みは尽きません。本勉強会では、ドキュメントを作成したくなってしまう魔法のツール「Sphinx」をご紹介します。 「Sp
Sphinxドメイン — Sphinx 1.5.6 ドキュメント
ドメインとは何か？¶ 当初、Sphinxは一つのプロジェクトと、Pythonの言語のドキュメントのために作られました。その後少し経って、汎用的なドキュメントツールとして作り直されましたが、Pythonモジュールのドキュメントのため、という部分はツールの奥深くまで根を伸ばしたままでした。 function などのもっとも基本的なディレクティブは、Pythonのオブジェクトのために設計されました。しばらくたって、Sphinxはいくらか人気が出てきて、C/C++のプロジェクト、JavaScript, reStructuredText(このドキュメントのように)など、さまざまな異なる目的で使用したい、という要求が出てきました。 今までも書けないことはありませんでしたが、1.0からは、もっと簡単に、Sphinxでサポートしていない異なるプログラミング言語を使用したプロジェクトのドキュメントでも使える
Sphinxでblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整える - Qiita
Sphinxでblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整えるSphinxblockdiag 概要 Sphinx は Python で作成されたドキュメント生成ツール。 コード内コメントや .rst でかかれたファイル等を元に HTML/epub/PDF などのフォーマットのドキュメントを生成出来る。 この記事では .rst を用いたドキュメント生成方法をまとめている。 セットアップ HTMLでの出力をするまでの設定。 まずPython環境を用意する。virtualenv等で環境を切っておくと良い。 pip で sphinx インストール後、新しいディレクトリ内で sphinx-quickstart を使ってプロジェクト作成を行う。
Read the Docs(Sphinx)でオープンソースのドキュメントをいい感じに書いてみる
B! 139 0 0 0 最近良くGitHubなんかで公開されてるオープンソースのドキュメントを見ようとすると こんな感じの似たようなフォーマットで書かれているものが多くなっています。 余りに多いので最初GitHubのサービスかな、とか思ったんですが、 これはまた別のRead the Docsという ドキュメント用ホスティングサービスによるものでした。 Read the Docs Read the Docsでドキュメントを公開してみる Sphinxのインストール レポジトリ側の準備 Read the Docsへの登録 ページを作成 Indexページ ページ内容の編集(Markdown to reStructuredText) タイトル ハイパーリンク 画像 リンク付き画像 インラインマークアップ コードブロック リスト テーブル Pythonのモジュール説明 その他reStructured
遷移図生成ツール blockdiag の紹介 @ Pycon mini JP 2011/01
Pythonの処理系はどのように実装され，どのように動いているのか？ 我々はその実態を調査すべくアマゾンへと飛んだ．kiki utagawa
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Sphinx はどのように Python コードからドキュメントを生成するのか (tk0miya) [PyCon JP 2020]![Sphinx はどのように Python コードからドキュメントを生成するのか (tk0miya) [PyCon JP 2020]](https://cdn-ak-scissors.b.st-hatena.com/image/square/a4721691b792808c08dd30010fcf3e56d23741fd/height=288;version=1;width=512/https%3A%2F%2Fi.ytimg.com%2Fvi%2FFJtNT8gbtVQ%2Fmaxresdefault.jpg)
02-202_Sphinx-2.0 とドキュメントの未来(Takeshi KOMIYA)
Jupyter Notebook Tools for Sphinx — nbsphinx version 0.9.3