2012年10月29日月曜日

docs.python.org の更新

原文はこちら: Updates to docs.python.org

まだ気付いていない方もいるかもしれませんが、数ヶ月前に私たちは http://docs.python.org の Pthon 3.2 以降の Sphinx テーマを更新しました。よりモダンな外観で新しいバージョンのドキュメントをみているのを指し示すという意図もあります。Sphinx への Georg Brandl の取り組み、Python ドキュメント、そしてこの新しいテーマに感謝の意を表します。

PEP 430


週末にかけて PEP 430 が承認されました。その PEP は http://docs.python.org で表示するデフォルトのドキュメントを変更します。詳細は PEP を参照してもらうとして、その主旨はドキュメントホームのデフォルトを変更して、現在の Python 3 リリースを推進するようにしたことです。しかし、ほとんどの使用事例はまだ Python 2 向けのドキュメントなので、バージョン指定しないページは現在の Python 2 のドキュメントを表示するようにしています。例えば、 http://docs.python.org/library/zipfile のようなバージョン指定しないリンクは 2.7.3 のドキュメントを表示します。

バージョン番号のドロップダウンリスト


この変更に対応するには、新たな機能として全てのドキュメントページの上位にバージョン番号のドロップダウンリストを追加します。これはユーザーが閲覧したいものではないページが表示されたときに役立つだけでなく、各バージョンの切り替えが Python3 対応を行うプロジェクト作業をより一般的なものにするでしょう。 Issue 8040 でその変更とパッチに対する議論、Georg からの助言とともに Yury Selivanov が達成した多くの作業を目にするでしょう。

このドロップダウンリストは、あるページのドキュメントの別バージョンを表示して熟読したいときに特に便利です。他のバージョンを選択するときは、選択されたバージョンの最新のリリースを表示します。例えば、2.7 を選択すると 2.7.3 を指します。なので、2.7.3 の組み込み型のページを見ているなら、ドロップダウンリストの 3.3 を選択したときに 3.3.0 の組み込み型のページを表示します。

Python のドキュメントを参照するときにこれらの変更がより良い体験になることを願っています!