Sphinx autodoc� - automated API documentation (PyCon APAC 2015 in Taiwan)
Sphinx autodoc� - automated API documentation (PyCon APAC 2015 in Taiwan) This document discusses Sphinx, an open source documentation generator for Python projects. It describes how Sphinx works with reStructuredText markup and extensions like autodoc to automatically generate API documentation from docstrings in Python source code. Key points include setting up a Sphinx project, using directives
SphinxでドキュメンテーションコメントをHTMLに変換する方法
前フリ Pythonにはpydocというモジュールがあって、これを使うと同じようにAPIリストが出力できると思っていた。今までDjangoのコードを書いてみて、いわゆるヘッダーコメントとかドキュメンテーションコメントと言われているものをなんとなくjavadocライクに書いていたが、pydocだとあんまり期待した通りのHTMLを出力してくれないことが分かった。 自分が期待していたのは、 @タグでクラス、関数属性に関する情報を出力 phpDocumentorのように、テンプレートを変更可能 というものだったが、あんまりよろしくなかった。調べてみると、epydocというツールで実現できそうだったが、テンプレートはないらしい。もうちょっと調べてみると、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ページを開く
https://sphinx-users.jp/doc11/ext/autodoc.html
