同一项目中多个模块(不是Python)的Sphinx文档

时间:2019-05-06 16:34:37

标签: python documentation python-sphinx

我正在构建一个简单的非实时应用程序,我的问题是有关文档的最佳实践。这是风景:

MyApp
--- ui_angular
--- mongo_db
--- python_code

为了讨论方便,我将简化一下。我有一些数据。我的“ python_code”模块将吃掉数据并将摘要版本放入mongo_db。然后,我的角度ui将基于mongo_db中的结果渲染一些漂亮的图片。

我的python_code看起来像这样:

python_code
--- package1
--------moduleA
--------moduleB
--------setup.py
--- package2
--------moduleC
--------moduleD
--------setup.py
--- brains
--------code1.py
--------code2.py

这个想法是我写了两个软件包来支持“ brain”目录中的代码。 Brain是python文件的集合,这些文件将使用package1和package2的助手来解释数据。

我想使用Sphinx记录代码的python版本。我知道我可以运行sphinx quickstart,它将为我生成一些文档,并且我可以将Sphinx用于Package1,Package2和Brain分别在/ docs目录中生成三个单独的文件。

我想拥有3个版本的文档:

---- For User
--------- How to navigate the UI
---- For Developer
---------Documentation for package 1
---------Documentation for package 2
---- For Contributor
---------Documentation for Brain

我希望它是HTML。我的想法是,我希望某人登陆页面,可以选择“ for_user”,“ for_developer”或“ for_contributor”。如果他们选择“对于开发人员”,我希望Sphinx样式文档详细说明package1和package2的内容。但是,我希望所有文档都保持相同的文档样式。

以这种方式使用Sphinx的最佳实践是什么?

  • 选项1:使用Sphinx记录代码的每个单独部分,然后 然后创建一个单独链接到它们的HTML页面。

  • 选项2:Sphinx为您想到了这一点,因此请使用功能Y 生成一个项目范围的文档,然后将其自动提取 您指定目录中的较小文档。

是选项1,选项2还是其他一些选项?

0 个答案:

没有答案