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のイケてるドキュメントを自動デプロイしてS3で公開する！ | DevelopersIO
最近Sphinxつかってドキュメントを書いてるのですがなかなかイケています。 SphinxとはPython製ドキュメンテーションビルダーで、reStructuredTextという記法で書かれたテキストファイルをHTMLやPDFなどに変換することができます。 SphinxはPythonの公式ドキュメントなどにも使われており、見たことある方も多いのではないでしょうか。 今回は「Sphinxを自動デプロイ&公開する方法」を紹介したいと思います。 構成図 せっかちな人へ GitHubの方にソースコード全部あげています。 Sphinxのインストール 詳細は公式ドキュメントを確認ください。 pipenvを使ってライブラリをインストール pipenv install sphinx クイックスタート pipenv shell sphinx-quickstart 作成されたファイル $ tree -L 2
概要 — 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/
Sphinxのドキュメント作成を便利にする「sphinx-quickstart-plus」を作りました - Qiita
Welcome to the Sphinx 1.5.1 quickstart utility. Please enter values for the following settings (just press Enter to accept a default value, if one is given in brackets). Enter the root path for documentation. > Root path for the documentation [.]: document_path You have two options for placing the build directory for Sphinx output. Either, you use a directory "_build" within the root path, or you
日本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でblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整える - Qiita
Sphinxでblockdiagを使って簡単にシーケンス図、ブロック図を含めたHTMLベースのドキュメントを生成する環境を整えるSphinxblockdiag 概要 Sphinx は Python で作成されたドキュメント生成ツール。 コード内コメントや .rst でかかれたファイル等を元に HTML/epub/PDF などのフォーマットのドキュメントを生成出来る。 この記事では .rst を用いたドキュメント生成方法をまとめている。 セットアップ HTMLでの出力をするまでの設定。 まずPython環境を用意する。virtualenv等で環境を切っておくと良い。 pip で sphinx インストール後、新しいディレクトリ内で sphinx-quickstart を使ってプロジェクト作成を行う。
ドキュメントの継続的な開発方法 | IIJ Engineers Blog
私はソフトウェア開発を主体とするエンジニアで、 クラウドサービスの開発・運用 分散処理技術の検証とサービス利用の検討 社内の開発支援環境の開発・運用 などの業務に従事していますが、今回の記事は業務とは直接的な関係は無く、私が会社で勝手自発的に行っている取り組みについて書きたいと思います。 昨今、インターネットは生活に深く浸透し、クラウドサービスを利用することで安く簡単にWebサービスを開発、公開できるようになりました。Web技術の進化や流行の移り変りも非常に激しく、既存サービスの機能追加や新規サービスの開発は頻繁に行われています。それは弊社も例外ではありません。 このような開発の現場では、リーンソフトウェア開発への取り組みなど開発手法の最適化が積極的に行われ、様々なベストプラクティスが生みだされています。それらのベストプラクティスには、 継続的インテグレーション や 継続的デプロイメント
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
02-202_Sphinx-2.0 とドキュメントの未来(Takeshi KOMIYA)
Sphinx + blockdiag で始めるドキュメント生活 @ yokohama.pm 2011/05 | Webシステム開発／教育ソリューションのタイムインターメディア
遷移図生成ツール blodkdiag の紹介 / Python Workshop 2010/12
GitHub - iij/eng-blog-20160531: IIJエンジニアブログ 2016-05-30「ドキュメントの継続的な開発方法」