使用 Sphinx 记录多个 Python 项目
Using Sphinx to document multiple Python projects
我已经阅读了一些 Sphinx 教程,但我仍然对如何设置多个项目感到困惑。
我的意思是,在安装 Sphinx 之后,this guide 说
To get started, cd into the documentation directory and type: $ sphinx-quickstart
假设我有 5 个单独的 Python 项目,每个项目都在自己的目录中(所有单独的 git 存储库等)。
我的问题是,“文档目录” 到底是什么(除了显而易见的)以及在处理多个项目时如何设置 Sphinx ?
我是否在某处创建一个“主文档目录”,并且当我使用 Sphinx 时,我是否为每个项目或类似项目创建子目录?
或者我是否在我的每个项目中创建一个“文档目录”并 运行 $ sphinx-quickstart
为每个单独的项目设置 Sphinx?
我试图了解这里的大局,但找不到详细说明这方面内容的教程。
sphinx-quickstart
命令为单个项目生成文档框架,因此如果您有多个单独的项目,则必须在每个项目中运行其中之一。您发布的 link 使用短语 "documentation directory" 因为项目目录中的目录名称和相对位置由您决定(他们似乎将其放在 project_root/doc
), 不是因为你的所有项目都应该有一些集中的文档目录。
我已经阅读了一些 Sphinx 教程,但我仍然对如何设置多个项目感到困惑。
我的意思是,在安装 Sphinx 之后,this guide 说
To get started, cd into the documentation directory and type:
$ sphinx-quickstart
假设我有 5 个单独的 Python 项目,每个项目都在自己的目录中(所有单独的 git 存储库等)。
我的问题是,“文档目录” 到底是什么(除了显而易见的)以及在处理多个项目时如何设置 Sphinx ?
我是否在某处创建一个“主文档目录”,并且当我使用 Sphinx 时,我是否为每个项目或类似项目创建子目录?
或者我是否在我的每个项目中创建一个“文档目录”并 运行 $ sphinx-quickstart
为每个单独的项目设置 Sphinx?
我试图了解这里的大局,但找不到详细说明这方面内容的教程。
sphinx-quickstart
命令为单个项目生成文档框架,因此如果您有多个单独的项目,则必须在每个项目中运行其中之一。您发布的 link 使用短语 "documentation directory" 因为项目目录中的目录名称和相对位置由您决定(他们似乎将其放在 project_root/doc
), 不是因为你的所有项目都应该有一些集中的文档目录。