[B! Python][sphinx] manabouのブックマーク

忙しい研究者のためのテストコードとドキュメントの書き方 - Qiita

はじめに「研究用のプログラムにもテストコードやドキュメント書いたほうがいいよね。」「分かっちゃいるけど、そんな面倒なことやってられないよ。」という研究者あるあるを解決すべく、僕が普段実践している開発スタイルを紹介します。この開発スタイルのすごいところは：テストやドキュメントを一切書かない場合と比べて追加の工数がほぼゼロ。普通にコーディングしているだけで、いつのまにかテストコードとドキュメントまでできあがっている。実装、コメント、テスト、ドキュメントが自然に同期するので、保守しやすい。 Pythonを例に紹介しますが、コメント内にテストを書けるツールと、コメントからドキュメントを生成できるツールをもつ言語ならばどれにでも応用できるはずです。この開発スタイルに至った背景ソフトウェア開発において、テストコードやドキュメントを整備することでプログラムの品質が向上することは広く知

manabou 2018/05/28

リンク

テンプレートを使って爆速で機械学習プロジェクトを作成する - Qiita

├── LICENSE ├── Makefile <- Makefile with commands like `make data` or `make train` ├── README.md <- The top-level README for developers using this project. ├── data │ ├── external <- Data from third party sources. │ ├── interim <- Intermediate data that has been transf ormed. │ ├── processed <- The final, canonical data sets for modeling. │ └── raw <- The original, immutable data dump. │ ├── docs

manabou 2017/03/23

リンク

ドキュメンテーションツール「Sphinx」をチーム運用するまでの道のり - Librabuch | sphinx_documentation_advent_calendar_2013

本エントリは、次のAdvent Calendarのために書かれたものです。ドキュメンテーション Advent Calendar 2013 （12月15日）取り扱う内容株式会社ALBERTのシステム開発部では、ドキュメンテーションツールであるSphinxを積極的に活用しています。 Sphinxの導入、利用そのものは簡易に行うことができるのですが、開発部でチームとして運用するためにはいくつかの困難がありました。そんな幾重にも張り巡らされた困難を乗り越えて、2013年11月頃から本格的に運用が出来ているなぁ、と実感するに至ったので、今回は2013年の総決算としてその変遷を綴ります。関連資料 Pythonプロダクトを活用した開発チーム運営 in PyCon APAC 2013 - SlideShare SphinxをMarkdownで使い隊 - SlideShare Sphinxとわたし

manabou 2015/07/09

リンク

執筆中のPythonプロフェッショナルプログラミング第2版でsphinxを使っている話

システム開発や保守、運用の現場においてドキュメントは必須のものです。しかし、ドキュメントの作成・維持には多くのパワーがかかるため、ドキュメントが存在しない、資料が古いままになっているなどといった現状を多く耳にします。本勉強会ではこれらのドキュメントでよく利用される「図」にフォーカスし、みるみるうちに図を作成できる「blockdiag」をご紹介します。「blockdiag」はシンプルなテキスト記述からブロック図、ネットワーク図などの画像ファイルを出力可能なオープンソースの画像生成ツールです。書きやすさ、メンテナンスしやすさを中心にデザインされており、図を作るのに配置や並べ替えに苦労する必要はありません。 blockdiagのサンプルはこちらこのような特徴を持つ「blockdiag」と、シンプルな記述でドキュメントを作成するツール「Sphinx」を組み合わせることによって