Opened 3 years ago

Last modified 3 years ago

#2692 new project-idea

Auto-generate some documentation

Reported by: dustin Owned by:
Priority: major Milestone: 0.9.+
Version: Keywords: docs
Cc: keikun

Description

Lots of the Buildbot documentation is manually maintained to correspond to the code: buildstep arguments, data API descriptions, DB APIs, and so on.

It'd be great to have some means of automatically verifying or even generating that documentation. http://dexy.it/ looks like a useful general tool for building this kind of thing.

Scope

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.

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.

Change History (1)

comment:1 Changed 3 years ago by dustin

  • Cc keikun added

This could also involve automatically documenting step parameters, as suggested by KeiKun?.

Note: See TracTickets for help on using tickets.