记录来自不同编程语言的软件项目的最佳实践是哪种?

时间:2018-06-26 07:25:11

标签: git documentation doxygen python-sphinx read-the-docs

我想知道哪种方法可以用来记录软件并保持软件版本和文档的连贯性并支持开发人员之间的协作。

背景:

软件项目使用Python,C和JavaScript语言编写。根据项目,SW可以适应客户的需求。我们希望获得每个版本的快照及其相应的文档。

方法:

我们设置了一个自托管的Git服务器(例如自托管的readthedocs服务器)来构建和托管文档。根据编程语言,将修改config.py文件(在./docs/source文件夹中,其中包含readthedocs工具链的信息)。

推送到Git服务器后,readthedocs服务器由一个Webhook触发并构建文档。

该文档使用JSDoc,Doxygen或Sphinx(apidoc)构建。为了避免依赖性,我们直接使用Doxygen构建了C文档,而没有Sphinx和Breathe。 Wiki页面可以插入docs / source文件夹中。

现在我想知道这是否太多了,是否有较简单的实践来协作和记录软件项目。

0 个答案:

没有答案