2

项目我船舶的工作,它包含了不同语言的API包:使用Java,Python,C#,和其他人。所有这些API共享大部分相同的文档。该文档应在我们的网站上分别以PDF和HTML格式提供。用户通常会下载/浏览它感兴趣的一个。使用多种编程语言的一个项目中使用的狮身人面像

目前我们使用sdocml,但我们并不那么满意,所以我们想转移到更新的工具,我们正在考虑Sphinx。

望着狮身人面像的文档,我不能清楚地知道如何:

1-说产生了一定API的文档(例如在Java之一)

2-做车博士适用于任何领域?

3-是否有一个C#延伸?

任何帮助是最受欢迎的!

回答

0

,以不同的语言在一个狮身人面像的项目结合起来,最好的办法是写无车博士或自动生成的其他方式的文档。大多数情况下,它们仅适用于Python,即使某些扩展允许使用其他语言,在您注意到之前,您仍将被埋在不同的工作流程中。

从代码打捞您的文档,并将它们在你的项目中,甚至独立的存储设备的一个单独的文件夹docs在编写简洁的方式。您可以使用通用的Sphinx目录,如classmethod,不附带代码和几乎所有主要的编程语言。我为自己做了一个这样的项目,我需要在一个API中结合使用C,C++和Python代码,并且它是手动完成的。

如果造成这种分离项目,维护应该是太大的问题。与autodoc工作流相比,这并不困难。什么是PDF和HTML - 任何Sphinx项目都可以。查看他们的文档了解不同建设者的详细信息,如latexpdfhtml

相关问题