プロジェクトにスフィンクスを組み込んだファイル

Question

私は最初のプロジェクトをSphinx for PYPIにパッケージングしています。私はdocs/sourceフォルダのSphinxでドキュメントを作成しました。私の質問は、レポに組み込まれたドキュメンテーションも提供するのが慣例ですか？それは通常どのように行われますか？

私は多くの人がスフィンクスをインストールしたり聞いたりしないと思うので、私は尋ねています。彼らの生活を楽にしたいと思っています。

Answer 1

文書はソフトウェアではありません。

私は、README.rstとリリースノートを除いて、ドキュメントを含むPyPIのパッケージについて知らない。ドキュメントを含むものがあるかもしれません。

パッケージにドキュメントがある場合、docsフォルダをリポジトリのパッケージのソースフォルダに兄弟として配置するのが一般的です。その後、PyPIにリリースすると、ソースフォルダのみがアップロードされます。

PyPIリリースにドキュメントを含めることはできませんが、不要なダウンロード時間や、パッケージをインストールした後にファイルシステム上のドキュメントを見つけることができないなど、否定的なものがあります。代わりがあります。 Read the Docsは、リポジトリの変更ごとにドキュメントを作成し、HTML形式（オンラインまたはダウンロード可能な.zip形式）、PDF形式、またはePub形式で利用できるように設定できる一般的なサービスです。