Package buildbot :: Package steps :: Module python :: Class Sphinx

Class Sphinx

process.properties.PropertiesMixin --+            
                                     |            
           process.buildstep.BuildStep --+        
                                         |        
        process.buildstep.LoggingBuildStep --+    
                                             |    
                            shell.ShellCommand --+
                                                 |
                                                Sphinx

A Step to build sphinx documentation

Instance Methods

__init__(self, sphinx_sourcedir='.', sphinx_builddir=None, sphinx_builder=None, sphinx='sphinx-build', tags=[], defines={}, mode='incremental', **kwargs) source code

createSummary(self, log)

source code

evaluateCommand(self, cmd)

source code

describe(self, done=False)
Return a list of short strings to describe this step, for the status display.

source code

Inherited from shell.ShellCommand: buildCommandKwargs, getWorkdir, setBuild, setCommand, setDefaultWorkdir, setStepStatus, setupEnvironment, start

Inherited from process.buildstep.LoggingBuildStep: addLogFile, checkDisconnect, commandComplete, getText, getText2, interrupt, maybeGetText2, setStatus, setupLogfiles, startCommand

Inherited from process.buildstep.BuildStep: __provides__, acquireLocks, addCompleteLog, addFactoryArguments, addHTMLLog, addLog, addLogObserver, addURL, failed, finished, getLog, getSlaveName, getStepFactory, releaseLocks, runCommand, setBuildSlave, setProgress, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Inherited from process.properties.PropertiesMixin: __providedBy__, getProperties, getProperty, hasProperty, has_key, render, setProperty

Class Variables
	name = `'sphinx'`
	description = `['running', 'sphinx']`
	descriptionDone = `['sphinx']`
	haltOnFailure = `True`
Inherited from `shell.ShellCommand`: `flunkOnFailure`, `renderables` Inherited from `process.buildstep.LoggingBuildStep`: `cmd`, `parms`, `progressMetrics` Inherited from `process.buildstep.BuildStep`: `__implemented__`, `alwaysRun`, `build`, `doStepIf`, `flunkOnWarnings`, `hideStepIf`, `locks`, `progress`, `set_runtime_properties`, `step_status`, `useProgress`, `warnOnFailure`, `warnOnWarnings`

Instance Variables
Inherited from `shell.ShellCommand`: `command`, `lazylogfiles`, `logfiles`

Method Details

init(self, sphinx_sourcedir=`'.'`, sphinx_builddir=None, sphinx_builder=None, sphinx=`'sphinx-build'`, tags=`[]`, defines=`{}`, mode=`'incremental'`, **kwargs)
(Constructor)

source code

Overrides: process.buildstep.BuildStep.__init__

Return a list of short strings to describe this step, for the status display. This uses the first few words of the shell command. You can replace this by setting .description in your subclass, or by overriding this method to describe the step better.

Parameters:

done - whether the command is complete or not, to improve the way the command is described. done=False is used while the command is still running, so a single imperfect-tense verb is appropriate ('compiling', 'testing', ...) done=True is used when the command has finished, and the default getText() method adds some text, so a simple noun is appropriate ('compile', 'tests' ...)

Overrides: process.buildstep.BuildStep.describe

Class Sphinx

__init__(self, sphinx_sourcedir='.', sphinx_builddir=None, sphinx_builder=None, sphinx='sphinx-build', tags=[], defines={}, mode='incremental', **kwargs) (Constructor)

createSummary(self, log)

evaluateCommand(self, cmd)

describe(self, done=False)

init(self, sphinx_sourcedir=`'.'`, sphinx_builddir=None, sphinx_builder=None, sphinx=`'sphinx-build'`, tags=`[]`, defines=`{}`, mode=`'incremental'`, **kwargs)
(Constructor)