pypi 公開

[uchihashikenshi]

目的

PyPI にパッケージの本公開を行う。

提案内容

パッケージの公開用の諸作業を整理し、こちらにまとめつつ追加作業などもコメントで議論する。

タスク

• ドキュメントへのリンクを readme.md に載せる
• readme.md の冒頭の license と pypi の表示を最終バージョンに
• How to install? を安定版用に
• その他いろいろ・・・

関連

• テスト公開 #27

[uchihashikenshi]

ドキュメントの公開手順。

まず、/docs にAPIドキュメント用の Sphinx プロジェクトを作成する。

$ sphinx-apidoc -F -o docs/ matchernet_py_001/
$ ls docs/
Makefile              conf.py
_build                index.rst
_static               make.bat
_templates            matchernet_py_001.rst

Makefile ができているので、make を実行することでドキュメントが自動生成される。

$ cd docs
$ make html

docs/_build/html 配下に、HTML ファイルができている。

$ ls html/
_modules               matchernet_py_001.html
_sources               objects.inv
_static                py-modindex.html
genindex.html          search.html
index.html             searchindex.js

ドキュメントとして公開されるのは docs/ 以下であるため、docs/_build/html のファイルをdocs 以下に持ってくる必要がある。

# pwd: docs
$ cp -pr _build/html/* ./
$ cp -pr _build/html/.nojekyll ./

隠しファイルはデフォルトでコピーできないので、別途 .nojekyll のコピーも行っている。 以上を行ったあと、add & commit & push でドキュメントが更新される。

[uchihashikenshi]

ドキュメントへのリンク: https://shigeyukioba.github.io/matchernet/

[uchihashikenshi]

readme にドキュメントへのリンクを追加（紐付け忘れたので手動でコメント） https://github.com/shigeyukioba/matchernet/commit/8c9201eb030617680c4d63ff0094e21054e5b829

[uchihashikenshi]

pypi 公開手順。

$ rm -f -r matchernet.egg-info/* dist/*
$ python setup.py sdist bdist_wheel
$ twine upload --repository pypi dist/*