Python Sphinx内置文件在项目中

我正在用Sphinx为PYPI打包我的第一个项目。我用Sphinx在

docs/source

文件夹中创建了文档。我的问题是：回购协议中是否也提供构建文档？通常是怎么做的

---

我这么问是因为我可以想象很多人都没有安装斯芬克斯，甚至没有听说过斯芬克斯。我也想让他们的生活更轻松。

文档不是软件

除了它的

README.rst

和发行说明之外，我不知道PyPI上有任何包含文档的包。可能有一些包含文档

如果包有文档，通常会将

docs

文件夹作为存储库中包的源文件夹的同级文件夹。然后，当发布到PyPI时，只上载源文件夹

---

这并不意味着您不能在PyPI版本中包含文档，但也存在一些负面影响，包括不必要的下载时间，以及用户在安装软件包后无法在其文件系统中找到文档。还有其他选择。是一种流行的服务，可配置为根据存储库的每次更改生成文档，并以HTML（联机或可下载的.zip）、PDF或ePub格式提供文档。

文档不是软件

除了它的

README.rst

和发行说明之外，我不知道PyPI上有任何包含文档的包。可能有一些包含文档

如果包有文档，通常会将

docs

文件夹作为存储库中包的源文件夹的同级文件夹。然后，当发布到PyPI时，只上载源文件夹

---

这并不意味着您不能在PyPI版本中包含文档，但也存在一些负面影响，包括不必要的下载时间，以及用户在安装软件包后无法在其文件系统中找到文档。还有其他选择。是一种流行的服务，可以配置为根据对存储库的每次更改生成文档，并以HTML（联机或可下载的.zip）、PDF或ePub格式提供文档。

谢谢@Steve，我将按照您的建议将

文档

放在包的源文件夹的同级文件夹中。但是在

MANIFEST.in

中，我包括

docs/source/*

斯芬克斯源文件所在的位置。你是说我不应该？不<代码>文档是存放

.rst

文件的地方

src

或

mypackage

是保存包源代码的地方。请参阅以获取常见模式。您还可以在该repo中的HACKING.txt中找到关于我们如何构建文档的其他有用信息。谢谢@Steve，正如您所建议的，我正在将

文档

放在包的源文件夹的同级文件夹中。但是在

MANIFEST.in

中，我包括

docs/source/*

斯芬克斯源文件所在的位置。你是说我不应该？不<代码>文档是存放

.rst

文件的地方

src

或

mypackage

是保存包源代码的地方。请参阅以获取常见模式。您还可以在该repo的HACKING.txt中找到关于我们如何构建文档的其他有用信息。