使用Sphinx记录多个Python项目

我已经阅读了一些Sphinx教程，但我仍然有点挂起了如何设置多个项目

我的意思是，在安装Sphinx之后

要开始，请将cd放入文档目录并键入：

$sphinx quickstart

假设我在自己的目录中有5个单独的Python项目（所有单独的git repo等）

我的问题是，“文档目录”到底是什么（除了显而易见的之外）以及在处理多个项目时如何设置Sphinx？

我是否在某处创建了一个“主文档目录”，并且在使用Sphinx时，是否为每个项目或类似项目创建子目录

还是在每个项目中创建一个“文档目录”，然后运行

$sphinx quickstart

为每个项目设置sphinx

---

我试图理解这里的大局，但找不到详细说明这方面内容的教程。

sphinx quickstart命令为单个项目生成文档框架，因此如果您有多个单独的项目，则必须在每个项目中运行它。您发布的链接使用短语“documentation directory”（文档目录），因为项目目录中的目录名和相对位置由您决定（他们似乎将其放在

project\u root/doc

），而不是因为您的所有项目都应该有一些集中的文档目录

sphinx quickstart命令为单个项目生成文档框架，因此如果有多个单独的项目，则必须在每个项目中运行它。您发布的链接使用短语“documentation directory”（文档目录），因为项目目录中的目录名和相对位置由您决定（他们似乎将其放在

project\u root/doc

），而不是因为您的所有项目都应该有一些集中的文档目录

“设置多个项目”是什么意思。如果它们是分开的，在不同的目录中，那么您当然需要

-quickstart

每个目录。还是你想把它们结合起来？@jornsharpe这就是我想的，但我只是不确定。对我来说，教程没有明确说明文档目录应该在哪里。我不确定Sphinx是否希望此文件夹像我所有文档的中央回购，或者

Sphinx quickstart

是否打算像

git init

等那样按项目运行。您的答案似乎是每个项目设置的较晚。建议在我的Python项目中还是在它的外部创建文档目录？它读作“documentation directory”，因为项目目录中的目录名和相对位置由您决定。我通常把它放在

project\u root/docs

per中。看着你发布的链接，他们似乎使用了

doc

。@jornsharpe感谢你抽出时间，并将我引向那篇很棒的博客文章！如果你想给出一个答案，我接受：）你说的“建立多个项目”是什么意思。如果它们是分开的，在不同的目录中，那么您当然需要

-quickstart

每个目录。还是你想把它们结合起来？@jornsharpe这就是我想的，但我只是不确定。对我来说，教程没有明确说明文档目录应该在哪里。我不确定Sphinx是否希望此文件夹像我所有文档的中央回购，或者

Sphinx quickstart

是否打算像

git init

等那样按项目运行。您的答案似乎是每个项目设置的较晚。建议在我的Python项目中还是在它的外部创建文档目录？它读作“documentation directory”，因为项目目录中的目录名和相对位置由您决定。我通常把它放在

project\u root/docs

per中。看着你发布的链接，他们似乎使用了

doc

。@jornsharpe感谢你抽出时间，并将我引向那篇很棒的博客文章！如果你想给出答案，我会接受：）