我正在开发的项目包含一个包，其中包含适用于不同语言的 API：Java、Python、C# 等。所有这些 API 大多共享相同的文档。文档应在我们的网站上分别以 PDF 和 HTML 格式提供。用户通常会下载/浏览其感兴趣的内容。
目前我们使用 sdocml，但我们并不满意，因此我们希望使用更新的工具，我们正在考虑使用 Sphinx。
查看 Sphinx 文档，我无法清楚地弄清楚如何：
1- 说为某个 API 生成文档（例如 Java 的）
2- autodoc 是否适用于任何域？
3- 有 c# 扩展吗？
欢迎任何帮助！
【问题讨论】：
标签： documentation python-sphinx documentation-generation autodoc
在一个 Sphinx 项目中结合不同语言的最佳方法是编写不带 autodoc 或其他自动生成方式的文档。在大多数情况下，它们仅适用于 Python，即使某些扩展确实允许其他语言，您甚至会在没有注意到之前就被埋在不同的工作流程中。
从代码中拯救您的文档，并以简洁的方式将它们写入项目的单独 docs 文件夹甚至单独的存储库中。您可以使用通用 Sphinx 目录，例如 class 或 method，无需附加代码，几乎适用于任何主要编程语言。我自己做了一个这样的项目，我需要将 C、C++ 和 Python 代码组合到一个 API 中，并且是手动完成的。
如果您创建这种独立的项目，维护应该是一个很大的问题。这并不比 autodoc 工作流程难多少。 PDF 和 HTML 是什么——任何 Sphinx 项目都允许这样做。有关 latexpdf 或 html 等不同构建器的详细信息，请参阅他们的文档。
【讨论】：