備忘録的な

プログラミングや機械学習に関する備忘録

PyPIへのパッケージのドキュメント登録

PyPIのDocumentation Hostingを利用して自作パッケージのマニュアル等を登録します.
登録したドキュメントは

http://pythonhosted.org/<project_name>

で見ることができます.

登録の仕方は以下の通り.

  • ドキュメントを用意する

今回はSphinxを利用してドキュメントを作成しました.とりあえず

sphinx-quickstart

で作成したドキュメントがあると想定して話を進めます.
ディレクトリ構成は以下のようになっています.

package_root_dir/
|-- README
|-- setup.py
|-- package
|   |-- __init__.py
|   |-- foo.py
|-- doc
|-- |-- source
|-- |-- build
|-- |-- |-- html

Sphinx-PyPI-uploadというパッケージをインストールします

pip install -U sphinx-pypi-upload
  • setup.cfgの作成

setup.cfgでドキュメントの場所などを指定します.

[build_sphinx]
source-dir = doc/source
build-dir  = doc/build
all_files  = 1

[upload_sphinx]
upload-dir = doc/build/html
  • ビルド
python setup.py build_sphinx
  • アップロード
python setup.py upload_sphinx

注意点として,私の環境ではアップロードのために .pypircファイルの内容を以下のように変更する必要がありました.これでPyPIへのアップロード等に影響が無いかはこれから確認します(←これだと問答無用でPyPIへアップロードされてしまい,pypitestへのアップロードができませんね...).

[server-login]
username:foo
password:bar