Opened 6 years ago

Last modified 4 years ago

#2440 new enhancement

Write custom Sphinx support for config class definitions

Reported by: dustin Owned by:
Priority: major Milestone: 0.9.+
Version: master Keywords: docs, sprint

Description (last modified by sa2ajj)

Buildbot has a number of change sources, schedulers, steps, and status listeners -- all of which are added to the configuration by calling their constructors. These are currently identified for indexing by constructs like

.. bb:sched:: NightlyTriggerable

and the parameters are listed simply as

    Blah blah blah

This has a few problems:

  • the output is ugly
  • it's not always clear what the parameters are
  • there's no good way to include "common parameters" for each class, without copy/pasting them all over the .rst files

With a little custom programming in the 'bb' Sphinx domain, this could probably be fixed. Something like

.. bb:sched:: NightlyTriggerable

    :includeparams common:
    :includeparams timed:
    :param integer someOtherParam: some other parameter for the scheduler

    This scheduler is a mix of the Nightly and Triggerable schedulers.

Change History (2)

comment:1 Changed 5 years ago by dustin

  • Milestone changed from 0.8.+ to 0.9.+

Ticket retargeted after milestone closed

comment:2 Changed 4 years ago by sa2ajj

  • Description modified (diff)
  • Version changed from 0.8.7p1 to master
Note: See TracTickets for help on using tickets.