Docutils プロジェクト ドキュメント 概要

Author:David Goodger
Contact:docutils-develop@lists.sourceforge.net
Date:$Date: 2012-01-03 19:23:53 +0000 (Tue, 03 Jan 2012) $
Revision:$Revision: 7302 $
Copyright:

このドキュメントは、パブリック ドメインで公開されています。

作業中の最新ドキュメントは、下記から個別にアクセスするか、 Docutils distribution の docs ディレクトリからアクセスできます。

Docutils が対象とする人たち

Docutils が対象とする人々はいくつかに分類することができます:

  1. エンドユーザ: reStructuredText や Docutils ツールの利用者です。 中には開発者 (例えば、ソースの docstrings に reStucturedText を活用する Python開発者など) もいますが、多くはありません。

  2. クライアントの開発者: Docutils をライブラリとして使う開発者や、 Docutils を使った開発をするプログラマです。

  3. コンポーネントの開発者: Docutils とは別に、アプリケーション固有の コンポーネントや、ディレクティブ、ロール等を実装する人です。

  4. コアの開発者: Docutils コードベースの開発者や、Docutils プロジェクトの コミュニティの関係者です。

  5. 再実装する開発者: Docutils の別の実装を行う開発者です。

これらのグループの間には重複する箇所がたくさんあります。ほとんど (おそらくすべて) のコア開発者、コンポーネント開発者、クライアント開発者、そして再実装者もエンド ユーザでもあります。 コア開発者はクライアント開発者でもあり、他のプロジェクトではコンポーネントベースの 開発者かも知れません。コンポーネント開発者は、クライアント開発者でもあります。

プロジェクトの要旨

これらのファイルは全てのプロジェクト関係者のためのものです。 Docutils プロジェクトディレクトリのトップにあります。

README.txt:

プロジェクト概要: クイックスタート、要件、インストール方法、使い方です。
COPYING.txt:

Docutils の再配布の条件、およびライセンスへのリンクです。
FAQ.txt:

Docutils のよくある質問です。 もし疑問や問題がある場合、ここに既に答えがあるかも知れません。
BUGS.txt:

既知のバグのリスト、およびバグレポートの仕方です。
RELEASE-NOTES.txt:
 

最近のリリースの主要な変更点の概要です。
HISTORY.txt:

詳細な変更履歴です。
THANKS.txt:

謝辞です。

user/: エンドユーザ向け 紹介 & チュートリアル素材

Docutils 一般:

特定の Writer について:

reStructuredText について:

エディタサポート:

ref/: 全ユーザ向け リファレンス素材

これらのファイルの多くは開発者の仕様として始まりましたが、いまは成熟し、 エンドユーザやクライアント開発者に利用され、参考資料となっています。 成功した仕様はリファレンスに進化します。

Docutils 一般:

"refs" ディレクトリにはありませんが、 PEP 258 は あらゆる Docutils 開発者が 必読のリファレンスです。

reStructuredText について:

有史以前のもの:

peps/: Python の拡張提案 (PEP)

master repository にある PEP は最新ではなかったり、ローカルバージョンで あったりするので注意してください。