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

Class Sphinx

                            object --+            
                                     |            
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)
x.__init__(...) initializes x; see help(type(x)) for signature source code

createSummary(self, log)

source code

evaluateCommand(self, cmd)

source code

describe(self, done=False)

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, releaseLocks, runCommand, setBuildSlave, setProgress, setupProgress, slaveVersion, slaveVersionIsOlderThan, startStep

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

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

Static Methods
Inherited from `process.buildstep.BuildStep`: `__new__`

Class Variables
	name = `'sphinx'`
	description = `['running', 'sphinx']`
	descriptionDone = `['sphinx']`
	haltOnFailure = `True`
Inherited from `shell.ShellCommand`: `descriptionSuffix`, `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`

Properties
Inherited from `object`: `__class__`

Method Details

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

source code

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__: (inherited documentation)

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)