Documentation 在使用多种编程语言的项目中使用Sphinx

我正在从事的项目提供了一个包含不同语言（Java、Python、C#等）API的包。所有这些API几乎共享相同的文档。该文件应在我们的网站上分别以PDF和HTML格式提供。用户通常下载/浏览感兴趣的内容

目前我们使用sdocml，但我们不太满意，所以我们想使用一个更先进的工具，我们正在考虑Sphinx

查看Sphinx文档，我无法清楚地了解如何：

1-假设为某个API（例如Java API）生成文档

2-autodoc是否适用于任何域

3-有c#分机吗

---

欢迎任何帮助

在一个Sphinx项目中组合不同语言的最佳方法是在不使用autodoc或其他自动生成方式的情况下编写文档。在大多数情况下，它们只适用于Python，即使某些扩展确实允许使用其他语言，在您注意到之前，您将被埋没在不同的工作流中

从代码中提取文档，并以简洁的方式将它们写入项目的一个单独的

docs

文件夹，甚至单独的存储库中。您可以使用像

class

或

method

这样的通用Sphinx目录，而不附加代码，并且几乎可以用于任何主要编程语言。我自己做了一个这样的项目，在这里我需要在一个API中结合C、C++和Python代码，并且手工完成。 如果您创建这种分离的项目，维护应该是一个很大的问题。这并不比autodoc工作流难多少。对于PDF和HTML，任何Sphinx项目都允许这样做。查看他们的文档以了解不同构建器的详细信息，如

latexpdf

或

html