Buildbot: Ticket #2692: Auto-generate some documentation <p> Lots of the Buildbot documentation is manually maintained to correspond to the code: buildstep arguments, data API descriptions, DB APIs, and so on. </p> <p> It'd be great to have some means of automatically verifying or even generating that documentation. <a class="ext-link" href=""><span class="icon">​</span></a> looks like a useful general tool for building this kind of thing. </p> <h2 id="Scope">Scope</h2> <p> This project would involve writing code and configuration to automate the documentation-generation process. This should take Buildbot's source code as input (preferably parsed by Python, rather than with regular expressions or some other text-mode process) and generate rst output that can then be processed using Sphinx. </p> <p> A good GSoC application will identify several areas of the documentation that can be converted to automatic generation. These should become milestones in the project schedule. </p> en-us Buildbot Trac 1.0.3.dev0 dustin Tue, 25 Feb 2014 02:39:35 GMT cc set <ul> <li><strong>cc</strong> <em>keikun</em> added </li> </ul> <p> This could also involve automatically documenting step parameters, as suggested by <a class="missing wiki">KeiKun?</a>. </p> Ticket